plotly API Reference
Full documentation for plotly (5.24.1)
plotly.colors
Python Library Documentation: package plotly.colors in plotly
NAME
plotly.colors - For a list of colors available in `plotly.colors`, please see
DESCRIPTION
* the `tutorial on discrete color sequences <https://plotly.com/python/discrete-color/#color-sequences-in-plotly-express>`_
* the `list of built-in continuous color scales <https://plotly.com/python/builtin-colorscales/>`_
* the `tutorial on continuous colors <https://plotly.com/python/colorscales/>`_
Color scales and sequences are available within the following namespaces
* cyclical
* diverging
* qualitative
* sequential
PACKAGE CONTENTS
FUNCTIONS
color_parser(colors, function)
Takes color(s) and a function and applies the function on the color(s)
In particular, this function identifies whether the given color object
is an iterable or not and applies the given color-parsing function to
the color or iterable of colors. If given an iterable, it will only be
able to work with it if all items in the iterable are of the same type
- rgb string, hex string or tuple
colorscale_to_colors(colorscale)
Extracts the colors from colorscale as a list
colorscale_to_scale(colorscale)
Extracts the interpolation scale values from colorscale as a list
convert_colors_to_same_type(colors, colortype='rgb', scale=None, return_default_colors=False, num_of_defualt_colors=2)
Converts color(s) to the specified color type
Takes a single color or an iterable of colors, as well as a list of scale
values, and outputs a 2-pair of the list of color(s) converted all to an
rgb or tuple color type, aswell as the scale as the second element. If
colors is a Plotly Scale name, then 'scale' will be forced to the scale
from the respective colorscale and the colors in that colorscale will also
be coverted to the selected colortype. If colors is None, then there is an
option to return portion of the DEFAULT_PLOTLY_COLORS
:param (str|tuple|list) colors: either a plotly scale name, an rgb or hex
color, a color tuple or a list/tuple of colors
:param (list) scale: see docs for validate_scale_values()
:rtype (tuple) (colors_list, scale) if scale is None in the function call,
then scale will remain None in the returned tuple
convert_colorscale_to_rgb(colorscale)
Converts the colors in a colorscale to rgb colors
A colorscale is an array of arrays, each with a numeric value as the
first item and a color as the second. This function specifically is
converting a colorscale with tuple colors (each coordinate between 0
and 1) into a colorscale with the colors transformed into rgb colors
convert_dict_colors_to_same_type(colors_dict, colortype='rgb')
Converts a colors in a dictionary of colors to the specified color type
:param (dict) colors_dict: a dictionary whose values are single colors
convert_to_RGB_255(colors)
Multiplies each element of a triplet by 255
Each coordinate of the color tuple is rounded to the nearest float and
then is turned into an integer. If a number is of the form x.5, then
if x is odd, the number rounds up to (x+1). Otherwise, it rounds down
to just x. This is the way rounding works in Python 3 and in current
statistical analysis to avoid rounding bias
:param (list) rgb_components: grabs the three R, G and B values to be
returned as computed in the function
find_intermediate_color(lowcolor, highcolor, intermed, colortype='tuple')
Returns the color at a given distance between two colors
This function takes two color tuples, where each element is between 0
and 1, along with a value 0 < intermed < 1 and returns a color that is
intermed-percent from lowcolor to highcolor. If colortype is set to 'rgb',
the function will automatically convert the rgb type to a tuple, find the
intermediate color and return it as an rgb color.
get_colorscale(name)
Returns the colorscale for a given name. See `named_colorscales` for the
built-in colorscales.
hex_to_rgb(value)
Calculates rgb values from a hex color code.
:param (string) value: Hex color string
:rtype (tuple) (r_value, g_value, b_value): tuple of rgb values
label_rgb(colors)
Takes tuple (a, b, c) and returns an rgb color 'rgb(a, b, c)'
make_colorscale(colors, scale=None)
Makes a colorscale from a list of colors and a scale
Takes a list of colors and scales and constructs a colorscale based
on the colors in sequential order. If 'scale' is left empty, a linear-
interpolated colorscale will be generated. If 'scale' is a specificed
list, it must be the same legnth as colors and must contain all floats
For documentation regarding to the form of the output, see
https://plot.ly/python/reference/#mesh3d-colorscale
:param (list) colors: a list of single colors
n_colors(lowcolor, highcolor, n_colors, colortype='tuple')
Splits a low and high color into a list of n_colors colors in it
Accepts two color tuples and returns a list of n_colors colors
which form the intermediate colors between lowcolor and highcolor
from linearly interpolating through RGB space. If colortype is 'rgb'
the function will return a list of colors in the same form.
named_colorscales()
Returns lowercased names of built-in continuous colorscales.
sample_colorscale(colorscale, samplepoints, low=0.0, high=1.0, colortype='rgb')
Samples a colorscale at specific points.
Interpolates between colors in a colorscale to find the specific colors
corresponding to the specified sample values. The colorscale can be specified
as a list of `[scale, color]` pairs, as a list of colors, or as a named
plotly colorscale. The samplepoints can be specefied as an iterable of specific
points in the range [0.0, 1.0], or as an integer number of points which will
be spaced equally between the low value (default 0.0) and the high value
(default 1.0). The output is a list of colors, formatted according to the
specified colortype.
unconvert_from_RGB_255(colors)
Return a tuple where each element gets divided by 255
Takes a (list of) color tuple(s) where each element is between 0 and
255. Returns the same tuples where each tuple element is normalized to
a value between 0 and 1
unlabel_rgb(colors)
Takes rgb color(s) 'rgb(a, b, c)' and returns tuple(s) (a, b, c)
This function takes either an 'rgb(a, b, c)' color or a list of
such colors and returns the color tuples in tuple(s) (a, b, c)
validate_colors(colors, colortype='tuple')
Validates color(s) and returns a list of color(s) of a specified type
validate_colors_dict(colors, colortype='tuple')
Validates dictionary of color(s)
validate_colorscale(colorscale)
Validate the structure, scale values and colors of colorscale.
validate_scale_values(scale)
Validates scale values from a colorscale
:param (list) scale: a strictly increasing list of floats that begins
with 0 and ends with 1. Its usage derives from a colorscale which is
a list of two-lists (a list with two elements) of the form
[value, color] which are used to determine how interpolation weighting
works between the colors in the colorscale. Therefore scale is just
the extraction of these values from the two-lists in order
DATA
DEFAULT_PLOTLY_COLORS = ['rgb(31, 119, 180)', 'rgb(255, 127, 14)', 'rg...
PLOTLY_SCALES = {'Blackbody': [[0, 'rgb(0,0,0)'], [0.2, 'rgb(230,0,0)'...
__all__ = ['named_colorscales', 'cyclical', 'diverging', 'sequential',...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\colors\__init__.py
plotly.data
Python Library Documentation: package plotly.data in plotly
NAME
plotly.data - Built-in datasets for demonstration, educational and test purposes.
PACKAGE CONTENTS
FUNCTIONS
carshare()
Each row represents the availability of car-sharing services near the centroid of a zone
in Montreal over a month-long period.
Returns:
A `pandas.DataFrame` with 249 rows and the following columns:
`['centroid_lat', 'centroid_lon', 'car_hours', 'peak_hour']`.
election()
Each row represents voting results for an electoral district in the 2013 Montreal
mayoral election.
Returns:
A `pandas.DataFrame` with 58 rows and the following columns:
`['district', 'Coderre', 'Bergeron', 'Joly', 'total', 'winner', 'result', 'district_id']`.
election_geojson()
Each feature represents an electoral district in the 2013 Montreal mayoral election.
Returns:
A GeoJSON-formatted `dict` with 58 polygon or multi-polygon features whose `id`
is an electoral district numerical ID and whose `district` property is the ID and
district name.
experiment(indexed=False)
Each row in this wide dataset represents the results of 100 simulated participants
on three hypothetical experiments, along with their gender and control/treatment group.
Returns:
A `pandas.DataFrame` with 100 rows and the following columns:
`['experiment_1', 'experiment_2', 'experiment_3', 'gender', 'group']`.
If `indexed` is True, the data frame index is named "participant"
gapminder(datetimes=False, centroids=False, year=None, pretty_names=False)
Each row represents a country on a given year.
https://www.gapminder.org/data/
Returns:
A `pandas.DataFrame` with 1704 rows and the following columns:
`['country', 'continent', 'year', 'lifeExp', 'pop', 'gdpPercap',
'iso_alpha', 'iso_num']`.
If `datetimes` is True, the 'year' column will be a datetime column
If `centroids` is True, two new columns are added: ['centroid_lat', 'centroid_lon']
If `year` is an integer, the dataset will be filtered for that year
iris()
Each row represents a flower.
https://en.wikipedia.org/wiki/Iris_flower_data_set
Returns:
A `pandas.DataFrame` with 150 rows and the following columns:
`['sepal_length', 'sepal_width', 'petal_length', 'petal_width', 'species', 'species_id']`.
medals_long(indexed=False)
This dataset represents the medal table for Olympic Short Track Speed Skating for the
top three nations as of 2020.
Returns:
A `pandas.DataFrame` with 9 rows and the following columns:
`['nation', 'medal', 'count']`.
If `indexed` is True, the 'nation' column is used as the index.
medals_wide(indexed=False)
This dataset represents the medal table for Olympic Short Track Speed Skating for the
top three nations as of 2020.
Returns:
A `pandas.DataFrame` with 3 rows and the following columns:
`['nation', 'gold', 'silver', 'bronze']`.
If `indexed` is True, the 'nation' column is used as the index and the column index
is named 'medal'
stocks(indexed=False, datetimes=False)
Each row in this wide dataset represents closing prices from 6 tech stocks in 2018/2019.
Returns:
A `pandas.DataFrame` with 100 rows and the following columns:
`['date', 'GOOG', 'AAPL', 'AMZN', 'FB', 'NFLX', 'MSFT']`.
If `indexed` is True, the 'date' column is used as the index and the column index
If `datetimes` is True, the 'date' column will be a datetime column
is named 'company'
tips(pretty_names=False)
Each row represents a restaurant bill.
https://vincentarelbundock.github.io/Rdatasets/doc/reshape2/tips.html
Returns:
A `pandas.DataFrame` with 244 rows and the following columns:
`['total_bill', 'tip', 'sex', 'smoker', 'day', 'time', 'size']`.
wind()
Each row represents a level of wind intensity in a cardinal direction, and its frequency.
Returns:
A `pandas.DataFrame` with 128 rows and the following columns:
`['direction', 'strength', 'frequency']`.
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\data\__init__.py
plotly.graph_objects
Python Library Documentation: package plotly.graph_objects in plotly
NAME
plotly.graph_objects
PACKAGE CONTENTS
CLASSES
builtins.dict(builtins.object)
plotly.graph_objs._deprecations.AngularAxis
plotly.graph_objs._deprecations.Annotation
plotly.graph_objs._deprecations.ColorBar
plotly.graph_objs._deprecations.Contours
plotly.graph_objs._deprecations.ErrorX
plotly.graph_objs._deprecations.ErrorY
plotly.graph_objs._deprecations.ErrorZ
plotly.graph_objs._deprecations.Font
plotly.graph_objs._deprecations.Histogram2dcontour
plotly.graph_objs._deprecations.Legend
plotly.graph_objs._deprecations.Line
plotly.graph_objs._deprecations.Margin
plotly.graph_objs._deprecations.Marker
plotly.graph_objs._deprecations.RadialAxis
plotly.graph_objs._deprecations.Scene
plotly.graph_objs._deprecations.Stream
plotly.graph_objs._deprecations.Trace
plotly.graph_objs._deprecations.XAxis
plotly.graph_objs._deprecations.XBins
plotly.graph_objs._deprecations.YAxis
plotly.graph_objs._deprecations.YBins
plotly.graph_objs._deprecations.ZAxis
builtins.list(builtins.object)
plotly.graph_objs._deprecations.Annotations
plotly.graph_objs._deprecations.Data
plotly.graph_objs._deprecations.Frames
plotly.basedatatypes.BaseFigure(builtins.object)
plotly.graph_objs._figure.Figure
plotly.basedatatypes.BaseFrameHierarchyType(plotly.basedatatypes.BasePlotlyType)
plotly.graph_objs._frame.Frame
plotly.basedatatypes.BaseLayoutType(plotly.basedatatypes.BaseLayoutHierarchyType)
plotly.graph_objs._layout.Layout
plotly.basedatatypes.BaseTraceType(plotly.basedatatypes.BaseTraceHierarchyType)
plotly.graph_objs._bar.Bar
plotly.graph_objs._barpolar.Barpolar
plotly.graph_objs._box.Box
plotly.graph_objs._candlestick.Candlestick
plotly.graph_objs._carpet.Carpet
plotly.graph_objs._choropleth.Choropleth
plotly.graph_objs._choroplethmap.Choroplethmap
plotly.graph_objs._choroplethmapbox.Choroplethmapbox
plotly.graph_objs._cone.Cone
plotly.graph_objs._contour.Contour
plotly.graph_objs._contourcarpet.Contourcarpet
plotly.graph_objs._densitymap.Densitymap
plotly.graph_objs._densitymapbox.Densitymapbox
plotly.graph_objs._funnel.Funnel
plotly.graph_objs._funnelarea.Funnelarea
plotly.graph_objs._heatmap.Heatmap
plotly.graph_objs._heatmapgl.Heatmapgl
plotly.graph_objs._histogram.Histogram
plotly.graph_objs._histogram2d.Histogram2d
plotly.graph_objs._histogram2dcontour.Histogram2dContour
plotly.graph_objs._icicle.Icicle
plotly.graph_objs._image.Image
plotly.graph_objs._indicator.Indicator
plotly.graph_objs._isosurface.Isosurface
plotly.graph_objs._mesh3d.Mesh3d
plotly.graph_objs._ohlc.Ohlc
plotly.graph_objs._parcats.Parcats
plotly.graph_objs._parcoords.Parcoords
plotly.graph_objs._pie.Pie
plotly.graph_objs._pointcloud.Pointcloud
plotly.graph_objs._sankey.Sankey
plotly.graph_objs._scatter.Scatter
plotly.graph_objs._scatter3d.Scatter3d
plotly.graph_objs._scattercarpet.Scattercarpet
plotly.graph_objs._scattergeo.Scattergeo
plotly.graph_objs._scattergl.Scattergl
plotly.graph_objs._scattermap.Scattermap
plotly.graph_objs._scattermapbox.Scattermapbox
plotly.graph_objs._scatterpolar.Scatterpolar
plotly.graph_objs._scatterpolargl.Scatterpolargl
plotly.graph_objs._scattersmith.Scattersmith
plotly.graph_objs._scatterternary.Scatterternary
plotly.graph_objs._splom.Splom
plotly.graph_objs._streamtube.Streamtube
plotly.graph_objs._sunburst.Sunburst
plotly.graph_objs._surface.Surface
plotly.graph_objs._table.Table
plotly.graph_objs._treemap.Treemap
plotly.graph_objs._violin.Violin
plotly.graph_objs._volume.Volume
plotly.graph_objs._waterfall.Waterfall
plotly.basewidget.BaseFigureWidget(plotly.basedatatypes.BaseFigure, ipywidgets.widgets.domwidget.DOMWidget)
plotly.graph_objs._figurewidget.FigureWidget
class AngularAxis(builtins.dict)
| AngularAxis(*args, **kwargs)
|
| plotly.graph_objs.AngularAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.AngularAxis
| - plotly.graph_objs.layout.polar.AngularAxis
|
| Method resolution order:
| AngularAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.AngularAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.AngularAxis
| - plotly.graph_objs.layout.polar.AngularAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Annotation(builtins.dict)
| Annotation(*args, **kwargs)
|
| plotly.graph_objs.Annotation is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| Method resolution order:
| Annotation
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Annotation is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Annotations(builtins.list)
| Annotations(*args, **kwargs)
|
| plotly.graph_objs.Annotations is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| Method resolution order:
| Annotations
| builtins.list
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Annotations is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.list:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.list:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.list:
|
| __new__(*args, **kwargs) class method of builtins.list
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.list:
|
| __hash__ = None
class Bar(plotly.basedatatypes.BaseTraceType)
| Bar(arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Bar
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Bar object
|
| The data visualized by the span of the bars is set in `y` if
| `orientation` is set to "v" (the default) and the labels are
| set in `x`. By setting `orientation` to "h", the roles are
| interchanged.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Bar`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units). In "stack" or "relative" barmode, traces that
| set "base" will be excluded and drawn in "overlay" mode
| instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.bar.ErrorX` instance or
| dict with compatible properties
| error_y
| :class:`plotly.graph_objects.bar.ErrorY` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.bar.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`. Anything contained in
| tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.bar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.bar.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.bar.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.bar.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.bar.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Bar
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| base
| Sets where the bar base is drawn (in position axis units). In
| "stack" or "relative" barmode, traces that set "base" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'base' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| basesrc
| Sets the source reference on Chart Studio Cloud for `base`.
|
| The 'basesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.bar.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.bar.ErrorY
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.bar.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `value` and `label`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.bar.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.bar.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.bar.marker.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| cornerradius
| Sets the rounding of corners. May be an integer
| number of pixels, or a percentage of bar width
| (as a string ending in %). Defaults to
| `layout.barcornerradius`. In stack or relative
| barmode, the first trace to set cornerradius is
| used for the whole stack.
| line
| :class:`plotly.graph_objects.bar.marker.Line`
| instance or dict with compatible properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.bar.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the position where the bar is drawn (in position axis
| units). In "group" barmode, traces that set "offset" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'offset' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetsrc
| Sets the source reference on Chart Studio Cloud for `offset`.
|
| The 'offsetsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the bars. With "v" ("h"), the value of
| the each bar spans along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.bar.Outsidetextfont
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.bar.selected.Marke
| r` instance or dict with compatible properties
| textfont
| :class:`plotly.graph_objects.bar.selected.Textf
| ont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.bar.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.bar.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the font used for `text`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.bar.Textfont
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `value`
| and `label`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.bar.unselected.Mar
| ker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.bar.unselected.Tex
| tfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.bar.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar width (in position axis units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| widthsrc
| Sets the source reference on Chart Studio Cloud for `width`.
|
| The 'widthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Barpolar(plotly.basedatatypes.BaseTraceType)
| Barpolar(arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)
|
| Method resolution order:
| Barpolar
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)
| Construct a new Barpolar object
|
| The data visualized by the radial span of the bars is set in
| `r`
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Barpolar`
| base
| Sets where the bar base is drawn (in radial axis
| units). In "stack" barmode, traces that set "base" will
| be excluded and drawn in "overlay" mode instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.barpolar.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.barpolar.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.barpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.barpolar.Stream` instance
| or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.barpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar angular width (in "thetaunit" units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
|
| Returns
| -------
| Barpolar
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| base
| Sets where the bar base is drawn (in radial axis units). In
| "stack" barmode, traces that set "base" will be excluded and
| drawn in "overlay" mode instead.
|
| The 'base' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| basesrc
| Sets the source reference on Chart Studio Cloud for `base`.
|
| The 'basesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dr
| Sets the r coordinate step.
|
| The 'dr' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dtheta
| Sets the theta coordinate step. By default, the `dtheta` step
| equals the subplot's period divided by the length of the `r`
| coordinates.
|
| The 'dtheta' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters
| (e.g. 'r+theta')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.barpolar.marker.Co
| lorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.barpolar.marker.Li
| ne` instance or dict with compatible properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
|
| The 'offset' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| offsetsrc
| Sets the source reference on Chart Studio Cloud for `offset`.
|
| The 'offsetsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| r
| Sets the radial coordinates
|
| The 'r' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| r0
| Alternate to `r`. Builds a linear space of r coordinates. Use
| with `dr` where `r0` is the starting coordinate and `dr` the
| step.
|
| The 'r0' property accepts values of any type
|
| Returns
| -------
| Any
|
| rsrc
| Sets the source reference on Chart Studio Cloud for `r`.
|
| The 'rsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.barpolar.selected.
| Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.barpolar.selected.
| Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.barpolar.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| polar subplot. If "polar" (the default value), the data refer
| to `layout.polar`. If "polar2", the data refer to
| `layout.polar2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'polar', that may be specified as the string 'polar'
| optionally followed by an integer >= 1
| (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets hover text elements associated with each bar. If a single
| string, the same string appears over all bars. If an array of
| string, the items are mapped in order to the this trace's
| coordinates.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| theta
| Sets the angular coordinates
|
| The 'theta' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the starting
| coordinate and `dtheta` the step.
|
| The 'theta0' property accepts values of any type
|
| Returns
| -------
| Any
|
| thetasrc
| Sets the source reference on Chart Studio Cloud for `theta`.
|
| The 'thetasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| thetaunit
| Sets the unit of input "theta" values. Has an effect only when
| on "linear" angular axes.
|
| The 'thetaunit' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['radians', 'degrees', 'gradians']
|
| Returns
| -------
| Any
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.barpolar.unselecte
| d.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.barpolar.unselecte
| d.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.barpolar.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar angular width (in "thetaunit" units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| widthsrc
| Sets the source reference on Chart Studio Cloud for `width`.
|
| The 'widthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Box(plotly.basedatatypes.BaseTraceType)
| Box(arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Box
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Box object
|
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2, i.e. the median) is marked by a line
| inside the box. The fences grow outward from the boxes' edges,
| by default they span +/- 1.5 times the interquartile range
| (IQR: Q3-Q1), The sample mean and standard deviation as well as
| notches and the sample, outlier and suspected outliers points
| can be optionally added to the box plot. The values and
| positions corresponding to each boxes can be input using two
| signatures. The first signature expects users to supply the
| sample values in the `y` data array for vertical boxes (`x` for
| horizontal boxes). By supplying an `x` (`y`) array, one box per
| distinct `x` (`y`) value is drawn If no `x` (`y`) list is
| provided, a single box is drawn. In this case, the box is
| positioned with the trace `name` or with `x0` (`y0`) if
| provided. The second signature expects users to supply the
| boxes corresponding Q1, median and Q3 statistics in the `q1`,
| `median` and `q3` data arrays respectively. Other box features
| relying on statistics namely `lowerfence`, `upperfence`,
| `notchspan` can be set directly by the users. To have plotly
| compute them or to show sample points besides the boxes, users
| can set the `y` data array for vertical boxes (`x` for
| horizontal boxes) to a 2D array with the outer length
| corresponding to the number of boxes in the traces and the
| inner length corresponding the sample size.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Box`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| boxmean
| If True, the mean of the box(es)' underlying
| distribution is drawn as a dashed line inside the
| box(es). If "sd" the standard deviation is also drawn.
| Defaults to True when `mean` is set. Defaults to "sd"
| when `sd` is set Otherwise defaults to False.
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the box(es) are shown with no sample
| points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set. Defaults to "all" under the q1/median/q3
| signature. Otherwise defaults to "outliers".
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step for multi-box traces set
| using q1/median/q3.
| dy
| Sets the y coordinate step for multi-box traces set
| using q1/median/q3.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.box.Hoverlabel` instance
| or dict with compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the box(es).
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.box.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.box.Line` instance or dict
| with compatible properties
| lowerfence
| Sets the lower fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `lowerfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the lower as the last sample
| point below 1.5 times the IQR.
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
| marker
| :class:`plotly.graph_objects.box.Marker` instance or
| dict with compatible properties
| mean
| Sets the mean values. There should be as many items as
| the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `mean` is not
| provided but a sample (in `y` or `x`) is set, we
| compute the mean for each box using the sample values.
| meansrc
| Sets the source reference on Chart Studio Cloud for
| `mean`.
| median
| Sets the median values. There should be as many items
| as the number of boxes desired.
| mediansrc
| Sets the source reference on Chart Studio Cloud for
| `median`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For box traces, the name will
| also be used for the position coordinate, if `x` and
| `x0` (`y` and `y0` if horizontal) are missing and the
| position axis is categorical
| notched
| Determines whether or not notches are drawn. Notches
| displays a confidence interval around the median. We
| compute the confidence interval as median +/- 1.57 *
| IQR / sqrt(N), where IQR is the interquartile range and
| N is the sample size. If two boxes' notches do not
| overlap there is 95% confidence their medians differ.
| See https://sites.google.com/site/davidsstatistics/home
| /notched-box-plots for more info. Defaults to False
| unless `notchwidth` or `notchspan` is set.
| notchspan
| Sets the notch span from the boxes' `median` values.
| There should be as many items as the number of boxes
| desired. This attribute has effect only under the
| q1/median/q3 signature. If `notchspan` is not provided
| but a sample (in `y` or `x`) is set, we compute it as
| 1.57 * IQR / sqrt(N), where N is the sample size.
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
| notchwidth
| Sets the width of the notches relative to the box'
| width. For example, with 0, the notches are as wide as
| the box(es).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the box(es). If 0, the sample points are places over
| the center of the box(es). Positive (negative) values
| correspond to positions to the right (left) for
| vertical boxes and above (below) for horizontal boxes
| q1
| Sets the Quartile 1 values. There should be as many
| items as the number of boxes desired.
| q1src
| Sets the source reference on Chart Studio Cloud for
| `q1`.
| q3
| Sets the Quartile 3 values. There should be as many
| items as the number of boxes desired.
| q3src
| Sets the source reference on Chart Studio Cloud for
| `q3`.
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| sd
| Sets the standard deviation values. There should be as
| many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3
| signature. If `sd` is not provided but a sample (in `y`
| or `x`) is set, we compute the standard deviation for
| each box using the sample values.
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to
| be drawn across any stddev range For example 1-stddev,
| 3-stddev, 5-stddev
| sdsrc
| Sets the source reference on Chart Studio Cloud for
| `sd`.
| selected
| :class:`plotly.graph_objects.box.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showwhiskers
| Determines whether or not whiskers are visible.
| Defaults to true for `sizemode` "quartiles", false for
| "sd".
| sizemode
| Sets the upper and lower bound for the boxes quartiles
| means box is drawn between Q1 and Q3 SD means the box
| is drawn between Mean +- Standard Deviation Argument
| sdmultiple (default 1) to scale the box size So it
| could be drawn 1-stddev, 3-stddev etc
| stream
| :class:`plotly.graph_objects.box.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.box.Unselected` instance
| or dict with compatible properties
| upperfence
| Sets the upper fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `upperfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the upper as the last sample
| point above 1.5 times the IQR.
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| width
| Sets the width of the box in data coordinate If 0
| (default value) the width is automatically selected
| based on the positions of other box traces in the same
| subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Box
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| boxmean
| If True, the mean of the box(es)' underlying distribution is
| drawn as a dashed line inside the box(es). If "sd" the standard
| deviation is also drawn. Defaults to True when `mean` is set.
| Defaults to "sd" when `sd` is set Otherwise defaults to False.
|
| The 'boxmean' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, 'sd', False]
|
| Returns
| -------
| Any
|
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier points
| are shown and points either less than 4*Q1-3*Q3 or greater than
| 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all
| sample points are shown If False, only the box(es) are shown
| with no sample points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is set.
| Defaults to "all" under the q1/median/q3 signature. Otherwise
| defaults to "outliers".
|
| The 'boxpoints' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['all', 'outliers', 'suspectedoutliers', False]
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step for multi-box traces set using
| q1/median/q3.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step for multi-box traces set using
| q1/median/q3.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.box.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual boxes or sample
| points or both?
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['boxes', 'points'] joined with '+' characters
| (e.g. 'boxes+points')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| jitter
| Sets the amount of jitter in the sample points drawn. If 0, the
| sample points align along the distribution axis. If 1, the
| sample points are drawn in a random jitter of width equal to
| the width of the box(es).
|
| The 'jitter' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.box.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of line bounding the box(es).
| width
| Sets the width (in px) of line bounding the
| box(es).
|
| Returns
| -------
| plotly.graph_objs.box.Line
|
| lowerfence
| Sets the lower fence values. There should be as many items as
| the number of boxes desired. This attribute has effect only
| under the q1/median/q3 signature. If `lowerfence` is not
| provided but a sample (in `y` or `x`) is set, we compute the
| lower as the last sample point below 1.5 times the IQR.
|
| The 'lowerfence' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
|
| The 'lowerfencesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| line
| :class:`plotly.graph_objects.box.marker.Line`
| instance or dict with compatible properties
| opacity
| Sets the marker opacity.
| outliercolor
| Sets the color of the outlier sample points.
| size
| Sets the marker size (in px).
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
|
| Returns
| -------
| plotly.graph_objs.box.Marker
|
| mean
| Sets the mean values. There should be as many items as the
| number of boxes desired. This attribute has effect only under
| the q1/median/q3 signature. If `mean` is not provided but a
| sample (in `y` or `x`) is set, we compute the mean for each box
| using the sample values.
|
| The 'mean' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| meansrc
| Sets the source reference on Chart Studio Cloud for `mean`.
|
| The 'meansrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| median
| Sets the median values. There should be as many items as the
| number of boxes desired.
|
| The 'median' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| mediansrc
| Sets the source reference on Chart Studio Cloud for `median`.
|
| The 'mediansrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover. For box traces, the name will also be used for
| the position coordinate, if `x` and `x0` (`y` and `y0` if
| horizontal) are missing and the position axis is categorical
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| notched
| Determines whether or not notches are drawn. Notches displays a
| confidence interval around the median. We compute the
| confidence interval as median +/- 1.57 * IQR / sqrt(N), where
| IQR is the interquartile range and N is the sample size. If two
| boxes' notches do not overlap there is 95% confidence their
| medians differ. See
| https://sites.google.com/site/davidsstatistics/home/notched-
| box-plots for more info. Defaults to False unless `notchwidth`
| or `notchspan` is set.
|
| The 'notched' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| notchspan
| Sets the notch span from the boxes' `median` values. There
| should be as many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3 signature. If
| `notchspan` is not provided but a sample (in `y` or `x`) is
| set, we compute it as 1.57 * IQR / sqrt(N), where N is the
| sample size.
|
| The 'notchspan' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
|
| The 'notchspansrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| notchwidth
| Sets the width of the notches relative to the box' width. For
| example, with 0, the notches are as wide as the box(es).
|
| The 'notchwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 0.5]
|
| Returns
| -------
| int|float
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| pointpos
| Sets the position of the sample points in relation to the
| box(es). If 0, the sample points are places over the center of
| the box(es). Positive (negative) values correspond to positions
| to the right (left) for vertical boxes and above (below) for
| horizontal boxes
|
| The 'pointpos' property is a number and may be specified as:
| - An int or float in the interval [-2, 2]
|
| Returns
| -------
| int|float
|
| q1
| Sets the Quartile 1 values. There should be as many items as
| the number of boxes desired.
|
| The 'q1' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| q1src
| Sets the source reference on Chart Studio Cloud for `q1`.
|
| The 'q1src' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| q3
| Sets the Quartile 3 values. There should be as many items as
| the number of boxes desired.
|
| The 'q3' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| q3src
| Sets the source reference on Chart Studio Cloud for `q3`.
|
| The 'q3src' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile for Q1
| and 75th percentile for Q3 as computed using method #10 (listed
| on http://jse.amstat.org/v14n3/langford.html). The "exclusive"
| method uses the median to divide the ordered dataset into two
| halves if the sample is odd, it does not include the median in
| either half - Q1 is then the median of the lower half and Q3
| the median of the upper half. The "inclusive" method also uses
| the median to divide the ordered dataset into two halves but if
| the sample is odd, it includes the median in both halves - Q1
| is then the median of the lower half and Q3 the median of the
| upper half.
|
| The 'quartilemethod' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['linear', 'exclusive', 'inclusive']
|
| Returns
| -------
| Any
|
| sd
| Sets the standard deviation values. There should be as many
| items as the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `sd` is not provided
| but a sample (in `y` or `x`) is set, we compute the standard
| deviation for each box using the sample values.
|
| The 'sd' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to be drawn
| across any stddev range For example 1-stddev, 3-stddev,
| 5-stddev
|
| The 'sdmultiple' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| sdsrc
| Sets the source reference on Chart Studio Cloud for `sd`.
|
| The 'sdsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.box.selected.Marke
| r` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.box.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showwhiskers
| Determines whether or not whiskers are visible. Defaults to
| true for `sizemode` "quartiles", false for "sd".
|
| The 'showwhiskers' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sizemode
| Sets the upper and lower bound for the boxes quartiles means
| box is drawn between Q1 and Q3 SD means the box is drawn
| between Mean +- Standard Deviation Argument sdmultiple (default
| 1) to scale the box size So it could be drawn 1-stddev,
| 3-stddev etc
|
| The 'sizemode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['quartiles', 'sd']
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.box.Stream
|
| text
| Sets the text elements associated with each sample value. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.box.unselected.Mar
| ker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.box.Unselected
|
| upperfence
| Sets the upper fence values. There should be as many items as
| the number of boxes desired. This attribute has effect only
| under the q1/median/q3 signature. If `upperfence` is not
| provided but a sample (in `y` or `x`) is set, we compute the
| upper as the last sample point above 1.5 times the IQR.
|
| The 'upperfence' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
|
| The 'upperfencesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| whiskerwidth
| Sets the width of the whiskers relative to the box' width. For
| example, with 1, the whiskers are as wide as the box(es).
|
| The 'whiskerwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| width
| Sets the width of the box in data coordinate If 0 (default
| value) the width is automatically selected based on the
| positions of other box traces in the same subplot.
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| x
| Sets the x sample data or coordinates. See overview for more
| info.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Sets the x coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y sample data or coordinates. See overview for more
| info.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Sets the y coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Candlestick(plotly.basedatatypes.BaseTraceType)
| Candlestick(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
|
| Method resolution order:
| Candlestick
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
| Construct a new Candlestick object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Candlestick`
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.candlestick.Decreasing`
| instance or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.candlestick.Hoverlabel`
| instance or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.candlestick.Increasing`
| instance or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.candlestick.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.candlestick.Line` instance
| or dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.candlestick.Stream`
| instance or dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Candlestick
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| close
| Sets the close values.
|
| The 'close' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| closesrc
| Sets the source reference on Chart Studio Cloud for `close`.
|
| The 'closesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| decreasing
| The 'decreasing' property is an instance of Decreasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Decreasing`
| - A dict of string/value properties that will be passed
| to the Decreasing constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the fill color. Defaults to a half-
| transparent variant of the line color, marker
| color, or marker line color, whichever is
| available.
| line
| :class:`plotly.graph_objects.candlestick.decrea
| sing.Line` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.candlestick.Decreasing
|
| high
| Sets the high values.
|
| The 'high' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| highsrc
| Sets the source reference on Chart Studio Cloud for `high`.
|
| The 'highsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
| split
| Show hover information (open, close, high, low)
| in separate labels.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Hoverlabel
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| increasing
| The 'increasing' property is an instance of Increasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Increasing`
| - A dict of string/value properties that will be passed
| to the Increasing constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the fill color. Defaults to a half-
| transparent variant of the line color, marker
| color, or marker line color, whichever is
| available.
| line
| :class:`plotly.graph_objects.candlestick.increa
| sing.Line` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.candlestick.Increasing
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| width
| Sets the width (in px) of line bounding the
| box(es). Note that this style setting can also
| be set per direction via
| `increasing.line.width` and
| `decreasing.line.width`.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Line
|
| low
| Sets the low values.
|
| The 'low' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lowsrc
| Sets the source reference on Chart Studio Cloud for `low`.
|
| The 'lowsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| open
| Sets the open values.
|
| The 'open' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| opensrc
| Sets the source reference on Chart Studio Cloud for `open`.
|
| The 'opensrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Stream
|
| text
| Sets hover text elements associated with each sample point. If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| this trace's sample points.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| whiskerwidth
| Sets the width of the whiskers relative to the box' width. For
| example, with 1, the whiskers are as wide as the box(es).
|
| The 'whiskerwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| x
| Sets the x coordinates. If absent, linear coordinate will be
| generated.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Carpet(plotly.basedatatypes.BaseTraceType)
| Carpet(arg=None, a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Carpet
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Carpet object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Carpet`
| 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
| :class:`plotly.graph_objects.carpet.Aaxis` instance or
| dict with compatible properties
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| A two dimensional array of y coordinates at each carpet
| point.
| b0
| Alternate to `b`. Builds a linear space of a
| coordinates. Use with `db` where `b0` is the starting
| coordinate and `db` the step.
| baxis
| :class:`plotly.graph_objects.carpet.Baxis` instance or
| dict with compatible properties
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| cheaterslope
| The shift applied to each successive row of data in
| creating a cheater plot. Only used if `x` is been
| omitted.
| color
| Sets default for all colors associated with this axis
| all at once: line, font, tick, and grid colors. Grid
| color is lightened by blending this with the plot
| background Individual pieces can override this.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the a coordinate step. See `a0` for more info.
| db
| Sets the b coordinate step. See `b0` for more info.
| font
| The default font used for axis & tick labels on this
| carpet
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.carpet.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| stream
| :class:`plotly.graph_objects.carpet.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| A two dimensional array of x coordinates at each carpet
| point. If omitted, the plot is a cheater plot and the
| xaxis is hidden by default.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| A two dimensional array of y coordinates at each carpet
| point.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Carpet
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| An array containing values of the first parameter value
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| a0
| Alternate to `a`. Builds a linear space of a coordinates. Use
| with `da` where `a0` is the starting coordinate and `da` the
| step.
|
| The 'a0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| aaxis
| The 'aaxis' property is an instance of Aaxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Aaxis`
| - A dict of string/value properties that will be passed
| to the Aaxis constructor
|
| Supported dict properties:
|
| arraydtick
| The stride between grid lines along the axis
| arraytick0
| The starting index of grid lines along the axis
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided, then `autorange` is set to False.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`.
| cheatertype
|
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| dtick
| The stride between grid lines along the axis
| endline
| Determines whether or not a line is drawn at
| along the final value of this axis. If True,
| the end line is drawn on top of the grid lines.
| endlinecolor
| Sets the line color of the end line.
| endlinewidth
| Sets the width (in px) of the end line.
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the axis line color.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the axis line.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| labelpadding
| Extra padding between label and the axis
| labelprefix
| Sets a axis label prefix.
| labelsuffix
| Sets a axis label suffix.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number
| minorgridcolor
| Sets the color of the grid lines.
| minorgridcount
| Sets the number of minor grid ticks per major
| grid tick
| minorgriddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| minorgridwidth
| Sets the width (in px) of the grid lines.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears.
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showticklabels
| Determines whether axis labels are drawn on the
| low side, the high side, both, or neither side
| of the axis.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| smoothing
|
| startline
| Determines whether or not a line is drawn at
| along the starting value of this axis. If True,
| the start line is drawn on top of the grid
| lines.
| startlinecolor
| Sets the line color of the start line.
| startlinewidth
| Sets the width (in px) of the start line.
| tick0
| The starting index of grid lines along the axis
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.carpet.
| aaxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.carpet.aaxis.tickformatstopdefaults), sets
| the default property values to use for elements
| of carpet.aaxis.tickformatstops
| tickmode
|
| tickprefix
| Sets a tick label prefix.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| title
| :class:`plotly.graph_objects.carpet.aaxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use carpet.aaxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleoffset
| Deprecated: Please use
| carpet.aaxis.title.offset instead. An
| additional amount by which to offset the title
| from the tick labels, given in pixels. Note
| that this used to be set by the now deprecated
| `titleoffset` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
|
| Returns
| -------
| plotly.graph_objs.carpet.Aaxis
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| b
| A two dimensional array of y coordinates at each carpet point.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| b0
| Alternate to `b`. Builds a linear space of a coordinates. Use
| with `db` where `b0` is the starting coordinate and `db` the
| step.
|
| The 'b0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| baxis
| The 'baxis' property is an instance of Baxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Baxis`
| - A dict of string/value properties that will be passed
| to the Baxis constructor
|
| Supported dict properties:
|
| arraydtick
| The stride between grid lines along the axis
| arraytick0
| The starting index of grid lines along the axis
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided, then `autorange` is set to False.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`.
| cheatertype
|
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| dtick
| The stride between grid lines along the axis
| endline
| Determines whether or not a line is drawn at
| along the final value of this axis. If True,
| the end line is drawn on top of the grid lines.
| endlinecolor
| Sets the line color of the end line.
| endlinewidth
| Sets the width (in px) of the end line.
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the axis line color.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the axis line.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| labelpadding
| Extra padding between label and the axis
| labelprefix
| Sets a axis label prefix.
| labelsuffix
| Sets a axis label suffix.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number
| minorgridcolor
| Sets the color of the grid lines.
| minorgridcount
| Sets the number of minor grid ticks per major
| grid tick
| minorgriddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| minorgridwidth
| Sets the width (in px) of the grid lines.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears.
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showticklabels
| Determines whether axis labels are drawn on the
| low side, the high side, both, or neither side
| of the axis.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| smoothing
|
| startline
| Determines whether or not a line is drawn at
| along the starting value of this axis. If True,
| the start line is drawn on top of the grid
| lines.
| startlinecolor
| Sets the line color of the start line.
| startlinewidth
| Sets the width (in px) of the start line.
| tick0
| The starting index of grid lines along the axis
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.carpet.
| baxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.carpet.baxis.tickformatstopdefaults), sets
| the default property values to use for elements
| of carpet.baxis.tickformatstops
| tickmode
|
| tickprefix
| Sets a tick label prefix.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| title
| :class:`plotly.graph_objects.carpet.baxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use carpet.baxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleoffset
| Deprecated: Please use
| carpet.baxis.title.offset instead. An
| additional amount by which to offset the title
| from the tick labels, given in pixels. Note
| that this used to be set by the now deprecated
| `titleoffset` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
|
| Returns
| -------
| plotly.graph_objs.carpet.Baxis
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| carpet
| An identifier for this carpet, so that `scattercarpet` and
| `contourcarpet` traces can specify a carpet plot on which they
| lie
|
| The 'carpet' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cheaterslope
| The shift applied to each successive row of data in creating a
| cheater plot. Only used if `x` is been omitted.
|
| The 'cheaterslope' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| color
| Sets default for all colors associated with this axis all at
| once: line, font, tick, and grid colors. Grid color is
| lightened by blending this with the plot background Individual
| pieces can override this.
|
| The 'color' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| da
| Sets the a coordinate step. See `a0` for more info.
|
| The 'da' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| db
| Sets the b coordinate step. See `b0` for more info.
|
| The 'db' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| font
| The default font used for axis & tick labels on this carpet
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.carpet.Font
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.carpet.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.carpet.Stream
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| A two dimensional array of x coordinates at each carpet point.
| If omitted, the plot is a cheater plot and the xaxis is hidden
| by default.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| A two dimensional array of y coordinates at each carpet point.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Choropleth(plotly.basedatatypes.BaseTraceType)
| Choropleth(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Choropleth
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Choropleth object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Choropleth`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choropleth.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choropleth.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choropleth.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choropleth.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choropleth.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choropleth.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choropleth.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Choropleth
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.choropl
| eth.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.choropleth.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of choropleth.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.choropleth.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| choropleth.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| choropleth.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.choropleth.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Only has an effect
| when `geojson` is set. Support nested property, for example
| "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| geo
| Sets a reference between this trace's geospatial coordinates
| and a geographic map. If "geo" (the default value), the
| geospatial coordinates refer to `layout.geo`. If "geo2", the
| geospatial coordinates refer to `layout.geo2`, and so on.
|
| The 'geo' property is an identifier of a particular
| subplot, of type 'geo', that may be specified as the string 'geo'
| optionally followed by an integer >= 1
| (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.)
|
| Returns
| -------
| str
|
| geojson
| Sets optional GeoJSON data associated with this trace. If not
| given, the features on the base map are used. It can be set as
| a valid GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or "Feature" with
| geometries of type "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'location+z')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| locationmode
| Determines the set of locations used to match entries in
| `locations` to regions on the map. Values "ISO-3", "USA-
| states", *country names* correspond to features on the base map
| and value "geojson-id" corresponds to features from a custom
| GeoJSON linked to the `geojson` attribute.
|
| The 'locationmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['ISO-3', 'USA-states', 'country names', 'geojson-id']
|
| Returns
| -------
| Any
|
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.choropleth.marker.
| Line` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the locations.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choropleth.selecte
| d.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choropleth.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Stream
|
| text
| Sets the text elements associated with each location.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choropleth.unselec
| ted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choropleth.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the color values.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Choroplethmap(plotly.basedatatypes.BaseTraceType)
| Choroplethmap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Choroplethmap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Choroplethmap object
|
| GeoJSON features to be filled are set in `geojson` The data
| that describes the choropleth value-to-color mapping is set in
| `locations` and `z`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Choroplethmap`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmap traces are placed above the water layers.
| If set to '', the layer will be inserted above every
| existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmap.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Choroplethmap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the choropleth polygons will be inserted before
| the layer with the specified ID. By default, choroplethmap
| traces are placed above the water layers. If set to '', the
| layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.choropl
| ethmap.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.choroplethmap.colorbar.tickformatstopdefaults
| ), sets the default property values to use for
| elements of
| choroplethmap.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.choroplethmap.colo
| rbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| choroplethmap.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| choroplethmap.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Support nested
| property, for example "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| geojson
| Sets the GeoJSON data associated with this trace. It can be set
| as a valid GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or "Feature" with
| geometries of type "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'location+z')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `properties` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| locations
| Sets which features found in "geojson" to plot using their
| feature `id` field.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.choroplethmap.mark
| er.Line` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the locations.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmap.sele
| cted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| map subplot. If "map" (the default value), the data refer to
| `layout.map`. If "map2", the data refer to `layout.map2`, and
| so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'map', that may be specified as the string 'map'
| optionally followed by an integer >= 1
| (e.g. 'map', 'map1', 'map2', 'map3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets the text elements associated with each location.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmap.unse
| lected.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the color values.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Choroplethmapbox(plotly.basedatatypes.BaseTraceType)
| Choroplethmapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Choroplethmapbox
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Choroplethmapbox object
|
| "choroplethmapbox" trace is deprecated! Please consider
| switching to the "choroplethmap" trace type and `map` subplots.
| Learn more at: https://plotly.com/javascript/maplibre-
| migration/ GeoJSON features to be filled are set in `geojson`
| The data that describes the choropleth value-to-color mapping
| is set in `locations` and `z`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Choroplethmapbox`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmapbox traces are placed above the water
| layers. If set to '', the layer will be inserted above
| every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
| l` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmapbox.Legendgro
| uptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmapbox.Unselecte
| d` instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Choroplethmapbox
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the choropleth polygons will be inserted before
| the layer with the specified ID. By default, choroplethmapbox
| traces are placed above the water layers. If set to '', the
| layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.choropl
| ethmapbox.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.choroplethmapbox.colorbar.tickformatstopdefau
| lts), sets the default property values to use
| for elements of
| choroplethmapbox.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.choroplethmapbox.c
| olorbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| choroplethmapbox.colorbar.title.font instead.
| Sets this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| choroplethmapbox.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Support nested
| property, for example "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| geojson
| Sets the GeoJSON data associated with this trace. It can be set
| as a valid GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or "Feature" with
| geometries of type "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'location+z')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `properties` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| locations
| Sets which features found in "geojson" to plot using their
| feature `id` field.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.choroplethmapbox.m
| arker.Line` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the locations.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmapbox.s
| elected.Marker` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Stream
|
| subplot
| mapbox subplots and traces are deprecated! Please consider
| switching to `map` subplots and traces. Learn more at:
| https://plotly.com/javascript/maplibre-migration/ Sets a
| reference between this trace's data coordinates and a mapbox
| subplot. If "mapbox" (the default value), the data refer to
| `layout.mapbox`. If "mapbox2", the data refer to
| `layout.mapbox2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'mapbox', that may be specified as the string 'mapbox'
| optionally followed by an integer >= 1
| (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets the text elements associated with each location.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmapbox.u
| nselected.Marker` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the color values.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class ColorBar(builtins.dict)
| ColorBar(*args, **kwargs)
|
| plotly.graph_objs.ColorBar is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.marker.ColorBar
| - plotly.graph_objs.surface.ColorBar
| - etc.
|
| Method resolution order:
| ColorBar
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ColorBar is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.marker.ColorBar
| - plotly.graph_objs.surface.ColorBar
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Cone(plotly.basedatatypes.BaseTraceType)
| Cone(arg=None, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Cone
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Cone object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Cone`
| anchor
| Sets the cones' anchor with respect to their x/y/z
| positions. Note that "cm" denote the cone's center of
| mass which corresponds to 1/4 from the tail to tip.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.cone.ColorBar` instance or
| dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.cone.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `norm` Anything contained in tag `<extra>`
| is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.cone.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.cone.Lighting` instance or
| dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.cone.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in
| the vector field) or as "absolute" value (in the same
| units as the vector field). To display sizes in actual
| vector length use "raw".
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally)
| corresponds to the minimum "time" to travel across two
| successive x/y/z positions at the average velocity of
| those two successive positions. All cones in a given
| trace use the same factor. With `sizemode` set to
| "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is
| 0.5. With `sizemode` set to "absolute", `sizeref` has
| the same units as the u/v/w vector field, its the
| default value is half the sample's maximum vector norm.
| stream
| :class:`plotly.graph_objects.cone.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the cones. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Cone
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| anchor
| Sets the cones' anchor with respect to their x/y/z positions.
| Note that "cm" denote the cone's center of mass which
| corresponds to 1/4 from the tail to tip.
|
| The 'anchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['tip', 'tail', 'cm', 'center']
|
| Returns
| -------
| Any
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here u/v/w norm) or the bounds set
| in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmin` must be set as
| well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as u/v/w norm. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmax` must be set as
| well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.cone.co
| lorbar.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.cone.colorbar.tickformatstopdefaults), sets
| the default property values to use for elements
| of cone.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.cone.colorbar.Titl
| e` instance or dict with compatible properties
| titlefont
| Deprecated: Please use cone.colorbar.title.font
| instead. Sets this color bar's title font. Note
| that the title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use cone.colorbar.title.side
| instead. Determines the location of color bar's
| title with respect to the color bar. Defaults
| to "top" when `orientation` if "v" and
| defaults to "right" when `orientation` if "h".
| Note that the title's location used to be set
| by the now deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.cone.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.cone.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `norm` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.cone.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.cone.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.cone.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in the
| vector field) or as "absolute" value (in the same units as the
| vector field). To display sizes in actual vector length use
| "raw".
|
| The 'sizemode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['scaled', 'absolute', 'raw']
|
| Returns
| -------
| Any
|
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally) corresponds to the
| minimum "time" to travel across two successive x/y/z positions
| at the average velocity of those two successive positions. All
| cones in a given trace use the same factor. With `sizemode` set
| to "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is 0.5. With
| `sizemode` set to "absolute", `sizeref` has the same units as
| the u/v/w vector field, its the default value is half the
| sample's maximum vector norm.
|
| The 'sizeref' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.cone.Stream
|
| text
| Sets the text elements associated with the cones. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| u
| Sets the x components of the vector field.
|
| The 'u' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'uhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| usrc
| Sets the source reference on Chart Studio Cloud for `u`.
|
| The 'usrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| v
| Sets the y components of the vector field.
|
| The 'v' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'vhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| vsrc
| Sets the source reference on Chart Studio Cloud for `v`.
|
| The 'vsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| w
| Sets the z components of the vector field.
|
| The 'w' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| whoverformat
| Sets the hover text formatting rulefor `w` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'whoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| wsrc
| Sets the source reference on Chart Studio Cloud for `w`.
|
| The 'wsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates of the vector field and of the displayed
| cones.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates of the vector field and of the displayed
| cones.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates of the vector field and of the displayed
| cones.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Contour(plotly.basedatatypes.BaseTraceType)
| Contour(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Contour
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
| Construct a new Contour object
|
| The data from which contour lines are computed is set in `z`.
| Data in `z` must be a 2D list of numbers. Say that `z` has N
| rows and M columns, then by default, these N rows correspond to
| N y coordinates (set in `y` or auto-generated) and the M
| columns correspond to M x coordinates (set in `x` or auto-
| generated). By setting `transpose` to True, the above behavior
| is flipped.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Contour`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contour.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array otherwise it
| is defaulted to false.
| contours
| :class:`plotly.graph_objects.contour.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.contour.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contour.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contour.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contour.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Contour
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocontour
| Determines whether or not the contour level attributes are
| picked by an algorithm. If True, the number of contour levels
| can be set in `ncontours`. If False, set the contour level
| attributes in `contours`.
|
| The 'autocontour' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.contour
| .colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.contour.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of contour.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.contour.colorbar.T
| itle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| contour.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| contour.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.contour.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data are filled in. It is defaulted to true if `z`
| is a one dimensional array otherwise it is defaulted to false.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| coloring
| Determines the coloring method showing the
| contour values. If "fill", coloring is done
| evenly between each contour level If "heatmap",
| a heatmap gradient coloring is applied between
| each contour level. If "lines", coloring is
| done on the contour lines. If "none", no
| coloring is applied on this trace.
| end
| Sets the end contour level value. Must be more
| than `contours.start`
| labelfont
| Sets the font used for labeling the contour
| levels. The default color comes from the lines,
| if shown. The default family and size come from
| `layout.font`.
| labelformat
| Sets the contour label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| operation
| Sets the constraint operation. "=" keeps
| regions equal to `value` "<" and "<=" keep
| regions less than `value` ">" and ">=" keep
| regions greater than `value` "[]", "()", "[)",
| and "(]" keep regions inside `value[0]` to
| `value[1]` "][", ")(", "](", ")[" keep regions
| outside `value[0]` to value[1]` Open vs. closed
| intervals make no difference to constraint
| display, but all versions are allowed for
| consistency with filter transforms.
| showlabels
| Determines whether to label the contour lines
| with their values.
| showlines
| Determines whether or not the contour lines are
| drawn. Has an effect only if
| `contours.coloring` is set to "fill".
| size
| Sets the step between each contour level. Must
| be positive.
| start
| Sets the starting contour level value. Must be
| less than `contours.end`
| type
| If `levels`, the data is represented as a
| contour plot with multiple levels displayed. If
| `constraint`, the data is represented as
| constraints with the invalid region shaded as
| specified by the `operation` and `value`
| parameters.
| value
| Sets the value or values of the constraint
| boundary. When `operation` is set to one of the
| comparison values (=,<,>=,>,<=) "value" is
| expected to be a number. When `operation` is
| set to one of the interval values
| ([],(),[),(],][,)(,](,)[) "value" is expected
| to be an array of two numbers where the first
| is the lower bound and the second is the upper
| bound.
|
| Returns
| -------
| plotly.graph_objs.contour.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line color,
| marker color, or marker line color, whichever is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
| - A number that will be interpreted as a color
| according to contour.colorscale
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.contour.Hoverlabel
|
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data have hover labels associated with them.
|
| The 'hoverongaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.contour.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour level. Has no
| effect if `contours.coloring` is set to
| "lines".
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| smoothing
| Sets the amount of smoothing for the contour
| lines, where 0 corresponds to no smoothing.
| width
| Sets the contour line width in (in px) Defaults
| to 0.5 when `contours.type` is "levels".
| Defaults to 2 when `contour.type` is
| "constraint".
|
| Returns
| -------
| plotly.graph_objs.contour.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ncontours
| Sets the maximum number of contour levels. The actual number of
| contours will be chosen automatically to be less than or equal
| to the value of `ncontours`. Has an effect only if
| `autocontour` is True or if `contours.size` is missing.
|
| The 'ncontours' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [1, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.contour.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.contour.Textfont
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Template string used for rendering the information
| text that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable}, for
| example "y: %{y}". Numbers are formatted using d3-format's
| syntax %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `x`, `y`,
| `z` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xtype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'xtype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ytype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'ytype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Contourcarpet(plotly.basedatatypes.BaseTraceType)
| Contourcarpet(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Contourcarpet
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
| Construct a new Contourcarpet object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Contourcarpet`
| a
| Sets the x coordinates.
| a0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| atype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| b
| Sets the y coordinates.
| b0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| btype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| carpet
| The `carpet` of the carpet axes on which this contour
| trace lies
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contourcarpet.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.contourcarpet.Contours`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the x coordinate step. See `x0` for more info.
| db
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contourcarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contourcarpet.Line`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contourcarpet.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Contourcarpet
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| Sets the x coordinates.
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| a0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'a0' property accepts values of any type
|
| Returns
| -------
| Any
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| atype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'atype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocontour
| Determines whether or not the contour level attributes are
| picked by an algorithm. If True, the number of contour levels
| can be set in `ncontours`. If False, set the contour level
| attributes in `contours`.
|
| The 'autocontour' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| b
| Sets the y coordinates.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| b0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'b0' property accepts values of any type
|
| Returns
| -------
| Any
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| btype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'btype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| carpet
| The `carpet` of the carpet axes on which this contour trace
| lies
|
| The 'carpet' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.contour
| carpet.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.contourcarpet.colorbar.tickformatstopdefaults
| ), sets the default property values to use for
| elements of
| contourcarpet.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.contourcarpet.colo
| rbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| contourcarpet.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| contourcarpet.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| coloring
| Determines the coloring method showing the
| contour values. If "fill", coloring is done
| evenly between each contour level If "lines",
| coloring is done on the contour lines. If
| "none", no coloring is applied on this trace.
| end
| Sets the end contour level value. Must be more
| than `contours.start`
| labelfont
| Sets the font used for labeling the contour
| levels. The default color comes from the lines,
| if shown. The default family and size come from
| `layout.font`.
| labelformat
| Sets the contour label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| operation
| Sets the constraint operation. "=" keeps
| regions equal to `value` "<" and "<=" keep
| regions less than `value` ">" and ">=" keep
| regions greater than `value` "[]", "()", "[)",
| and "(]" keep regions inside `value[0]` to
| `value[1]` "][", ")(", "](", ")[" keep regions
| outside `value[0]` to value[1]` Open vs. closed
| intervals make no difference to constraint
| display, but all versions are allowed for
| consistency with filter transforms.
| showlabels
| Determines whether to label the contour lines
| with their values.
| showlines
| Determines whether or not the contour lines are
| drawn. Has an effect only if
| `contours.coloring` is set to "fill".
| size
| Sets the step between each contour level. Must
| be positive.
| start
| Sets the starting contour level value. Must be
| less than `contours.end`
| type
| If `levels`, the data is represented as a
| contour plot with multiple levels displayed. If
| `constraint`, the data is represented as
| constraints with the invalid region shaded as
| specified by the `operation` and `value`
| parameters.
| value
| Sets the value or values of the constraint
| boundary. When `operation` is set to one of the
| comparison values (=,<,>=,>,<=) "value" is
| expected to be a number. When `operation` is
| set to one of the interval values
| ([],(),[),(],][,)(,](,)[) "value" is expected
| to be an array of two numbers where the first
| is the lower bound and the second is the upper
| bound.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| da
| Sets the x coordinate step. See `x0` for more info.
|
| The 'da' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| db
| Sets the y coordinate step. See `y0` for more info.
|
| The 'db' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line color,
| marker color, or marker line color, whichever is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
| - A number that will be interpreted as a color
| according to contourcarpet.colorscale
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour level. Has no
| effect if `contours.coloring` is set to
| "lines".
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| smoothing
| Sets the amount of smoothing for the contour
| lines, where 0 corresponds to no smoothing.
| width
| Sets the contour line width in (in px) Defaults
| to 0.5 when `contours.type` is "levels".
| Defaults to 2 when `contour.type` is
| "constraint".
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ncontours
| Sets the maximum number of contour levels. The actual number of
| contours will be chosen automatically to be less than or equal
| to the value of `ncontours`. Has an effect only if
| `autocontour` is True or if `contours.size` is missing.
|
| The 'ncontours' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [1, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Contours(builtins.dict)
| Contours(*args, **kwargs)
|
| plotly.graph_objs.Contours is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.contour.Contours
| - plotly.graph_objs.surface.Contours
| - etc.
|
| Method resolution order:
| Contours
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Contours is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.contour.Contours
| - plotly.graph_objs.surface.Contours
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Data(builtins.list)
| Data(*args, **kwargs)
|
| plotly.graph_objs.Data is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| Method resolution order:
| Data
| builtins.list
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Data is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.list:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.list:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.list:
|
| __new__(*args, **kwargs) class method of builtins.list
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.list:
|
| __hash__ = None
class Densitymap(plotly.basedatatypes.BaseTraceType)
| Densitymap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Densitymap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Densitymap object
|
| Draws a bivariate kernel density estimation with a Gaussian
| kernel from `lon` and `lat` coordinates and optional `z` values
| using a colorscale.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Densitymap`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymap trace will be inserted
| before the layer with the specified ID. By default,
| densitymap traces are placed below the first layer of
| type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymap
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Densitymap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the densitymap trace will be inserted before the
| layer with the specified ID. By default, densitymap traces are
| placed below the first layer of type symbol If set to '', the
| layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.density
| map.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.densitymap.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of densitymap.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.densitymap.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| densitymap.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| densitymap.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.densitymap.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.densitymap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.densitymap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| radius
| Sets the radius of influence of one `lon` / `lat` point in
| pixels. Increasing the value makes the densitymap trace
| smoother, but less detailed.
|
| The 'radius' property is a number and may be specified as:
| - An int or float in the interval [1, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| radiussrc
| Sets the source reference on Chart Studio Cloud for `radius`.
|
| The 'radiussrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.densitymap.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| map subplot. If "map" (the default value), the data refer to
| `layout.map`. If "map2", the data refer to `layout.map2`, and
| so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'map', that may be specified as the string 'map'
| optionally followed by an integer >= 1
| (e.g. 'map', 'map1', 'map2', 'map3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the points' weight. For example, a value of 10 would be
| equivalent to having 10 points of weight 1 in the same spot
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Densitymapbox(plotly.basedatatypes.BaseTraceType)
| Densitymapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Densitymapbox
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Densitymapbox object
|
| "densitymapbox" trace is deprecated! Please consider switching
| to the "densitymap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ Draws a
| bivariate kernel density estimation with a Gaussian kernel from
| `lon` and `lat` coordinates and optional `z` values using a
| colorscale.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Densitymapbox`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymapbox trace will be inserted
| before the layer with the specified ID. By default,
| densitymapbox traces are placed below the first layer
| of type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymapbox
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Densitymapbox
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the densitymapbox trace will be inserted before
| the layer with the specified ID. By default, densitymapbox
| traces are placed below the first layer of type symbol If set
| to '', the layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.density
| mapbox.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.densitymapbox.colorbar.tickformatstopdefaults
| ), sets the default property values to use for
| elements of
| densitymapbox.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.densitymapbox.colo
| rbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| densitymapbox.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| densitymapbox.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| radius
| Sets the radius of influence of one `lon` / `lat` point in
| pixels. Increasing the value makes the densitymapbox trace
| smoother, but less detailed.
|
| The 'radius' property is a number and may be specified as:
| - An int or float in the interval [1, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| radiussrc
| Sets the source reference on Chart Studio Cloud for `radius`.
|
| The 'radiussrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.Stream
|
| subplot
| mapbox subplots and traces are deprecated! Please consider
| switching to `map` subplots and traces. Learn more at:
| https://plotly.com/javascript/maplibre-migration/ Sets a
| reference between this trace's data coordinates and a mapbox
| subplot. If "mapbox" (the default value), the data refer to
| `layout.mapbox`. If "mapbox2", the data refer to
| `layout.mapbox2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'mapbox', that may be specified as the string 'mapbox'
| optionally followed by an integer >= 1
| (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the points' weight. For example, a value of 10 would be
| equivalent to having 10 points of weight 1 in the same spot
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class ErrorX(builtins.dict)
| ErrorX(*args, **kwargs)
|
| plotly.graph_objs.ErrorX is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorX
| - plotly.graph_objs.histogram.ErrorX
| - etc.
|
| Method resolution order:
| ErrorX
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ErrorX is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorX
| - plotly.graph_objs.histogram.ErrorX
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class ErrorY(builtins.dict)
| ErrorY(*args, **kwargs)
|
| plotly.graph_objs.ErrorY is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorY
| - plotly.graph_objs.histogram.ErrorY
| - etc.
|
| Method resolution order:
| ErrorY
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ErrorY is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorY
| - plotly.graph_objs.histogram.ErrorY
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class ErrorZ(builtins.dict)
| ErrorZ(*args, **kwargs)
|
| plotly.graph_objs.ErrorZ is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter3d.ErrorZ
|
| Method resolution order:
| ErrorZ
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ErrorZ is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter3d.ErrorZ
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Figure(plotly.basedatatypes.BaseFigure)
| Figure(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
|
| Method resolution order:
| Figure
| plotly.basedatatypes.BaseFigure
| builtins.object
|
| Methods defined here:
|
| __init__(self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
| Create a new :class:Figure 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 single trace instance
| (e.g. Scatter(...), Bar(...), etc.)
| - A list or tuple of dicts of string/value properties where:
| - The 'type' property specifies the trace type
| One of: ['bar', 'barpolar', 'box', 'candlestick',
| 'carpet', 'choropleth', 'choroplethmap',
| 'choroplethmapbox', 'cone', 'contour',
| 'contourcarpet', 'densitymap',
| 'densitymapbox', 'funnel', 'funnelarea',
| 'heatmap', 'heatmapgl', 'histogram',
| 'histogram2d', 'histogram2dcontour', 'icicle',
| 'image', 'indicator', 'isosurface', 'mesh3d',
| 'ohlc', 'parcats', 'parcoords', 'pie',
| 'pointcloud', 'sankey', 'scatter',
| 'scatter3d', 'scattercarpet', 'scattergeo',
| 'scattergl', 'scattermap', 'scattermapbox',
| 'scatterpolar', 'scatterpolargl',
| 'scattersmith', 'scatterternary', 'splom',
| 'streamtube', 'sunburst', 'surface', 'table',
| 'treemap', 'violin', 'volume', 'waterfall']
|
| - 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 :class:`plotly.graph_objs.Layout`
| - A dict of string/value properties that will be passed
| to the Layout constructor
|
| Supported dict properties:
|
| activeselection
| :class:`plotly.graph_objects.layout.Activeselec
| tion` instance or dict with compatible
| properties
| activeshape
| :class:`plotly.graph_objects.layout.Activeshape
| ` instance or dict with compatible properties
| annotations
| A tuple of
| :class:`plotly.graph_objects.layout.Annotation`
| instances or dicts with compatible properties
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults),
| sets the default property values to use for
| elements of layout.annotations
| 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.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. This is the default value;
| however it could be overridden for individual
| axes.
| barcornerradius
| Sets the rounding of bar corners. May be an
| integer number of pixels, or a percentage of
| bar width (as a string ending in %).
| 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 reduce "opacity" to
| see multiple bars.
| barnorm
| Sets the normalization for bar traces on the
| graph. With "fraction", the value of each bar
| is divided by the sum of all values at that
| location coordinate. "percent" is the same but
| multiplied by 100 to show percentages.
| boxgap
| Sets the gap (in plot fraction) between boxes
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| boxmode
| Determines how boxes at the same location
| coordinate are displayed on the graph. If
| "group", the boxes are plotted next to one
| another centered around the shared location. If
| "overlay", the boxes are plotted over one
| another, you might need to set "opacity" to see
| them multiple boxes. Has no effect on traces
| that have "width" set.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout
| the plot.
| clickmode
| Determines the mode of single click
| interactions. "event" is the default value and
| emits the `plotly_click` event. In addition
| this mode emits the `plotly_selected` event in
| drag modes "lasso" and "select", but with no
| event data attached (kept for compatibility
| reasons). The "select" flag enables selecting
| single data points via click. This mode also
| supports persistent selections, meaning that
| pressing Shift while clicking, adds to /
| subtracts from an existing selection. "select"
| with `hovermode`: "x" can be confusing,
| consider explicitly setting `hovermode`:
| "closest" when using this feature. Selection
| events are sent accordingly as long as "event"
| flag is set as well. When the "event" flag is
| missing, `plotly_click` and `plotly_selected`
| events are not fired.
| coloraxis
| :class:`plotly.graph_objects.layout.Coloraxis`
| instance or dict with compatible properties
| colorscale
| :class:`plotly.graph_objects.layout.Colorscale`
| instance or dict with compatible properties
| colorway
| Sets the default trace colors.
| computed
| Placeholder for exporting automargin-impacting
| values namely `margin.t`, `margin.b`,
| `margin.l` and `margin.r` in "full-json" mode.
| 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.
| 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.
| editrevision
| Controls persistence of user-driven changes in
| `editable: true` configuration, other than
| trace names and axis titles. Defaults to
| `layout.uirevision`.
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether
| given by `funnelareacolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendiciclecolors
| If `true`, the icicle slice colors (whether
| given by `iciclecolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendpiecolors
| If `true`, the pie slice colors (whether given
| by `piecolorway` or inherited from `colorway`)
| will be extended to three times its original
| length by first repeating every color 20%
| lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether
| given by `sunburstcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendtreemapcolors
| If `true`, the treemap slice colors (whether
| given by `treemapcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| font
| Sets the global font. Note that fonts used in
| traces and other layout components inherit from
| the global font.
| funnelareacolorway
| Sets the default funnelarea slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendfunnelareacolors`.
| funnelgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| funnelmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "stack", the bars are stacked on top of one
| another With "group", the bars are plotted next
| to one another centered around the shared
| location. With "overlay", the bars are plotted
| over one another, you might need to reduce
| "opacity" to see multiple bars.
| geo
| :class:`plotly.graph_objects.layout.Geo`
| instance or dict with compatible properties
| grid
| :class:`plotly.graph_objects.layout.Grid`
| instance or dict with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart
| analog of visible:'legendonly' but it can
| contain many labels, and can simultaneously
| hide slices from several pies/funnelarea charts
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud
| 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 Chart Studio Cloud (at
| https://chart-studio.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
| :class:`plotly.graph_objects.layout.Hoverlabel`
| instance or dict with compatible properties
| hovermode
| Determines the mode of hover interactions. If
| "closest", a single hoverlabel will appear for
| the "closest" point within the `hoverdistance`.
| If "x" (or "y"), multiple hoverlabels will
| appear for multiple points at the "closest" x-
| (or y-) coordinate within the `hoverdistance`,
| with the caveat that no more than one
| hoverlabel will appear per trace. If *x
| unified* (or *y unified*), a single hoverlabel
| will appear multiple points at the closest x-
| (or y-) coordinate within the `hoverdistance`
| with the caveat that no more than one
| hoverlabel will appear per trace. In this mode,
| spikelines are enabled by default perpendicular
| to the specified axis. If false, hover
| interactions are disabled.
| hoversubplots
| Determines expansion of hover effects to other
| subplots If "single" just the axis pair of the
| primary point is included without overlaying
| subplots. If "overlaying" all subplots using
| the main axis and occupying the same space are
| included. If "axis", also include stacked
| subplots using the same axis when `hovermode`
| is set to "x", *x unified*, "y" or *y unified*.
| iciclecolorway
| Sets the default icicle slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendiciclecolors`.
| images
| A tuple of
| :class:`plotly.graph_objects.layout.Image`
| instances or dicts with compatible properties
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the
| default property values to use for elements of
| layout.images
| legend
| :class:`plotly.graph_objects.layout.Legend`
| instance or dict with compatible properties
| map
| :class:`plotly.graph_objects.layout.Map`
| instance or dict with compatible properties
| mapbox
| :class:`plotly.graph_objects.layout.Mapbox`
| instance or dict with compatible properties
| margin
| :class:`plotly.graph_objects.layout.Margin`
| instance or dict with compatible properties
| meta
| Assigns extra meta information that can be used
| in various `text` attributes. Attributes such
| as the graph, axis and colorbar `title.text`,
| annotation `text` `trace.name` in legend items,
| `rangeselector`, `updatemenus` and `sliders`
| `label` text all support `meta`. One can access
| `meta` fields using template strings:
| `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an
| object for example `{key: value}` which can be
| accessed %{meta[key]}.
| metasrc
| Sets the source reference on Chart Studio Cloud
| for `meta`.
| minreducedheight
| Minimum height of the plot with
| margin.automargin applied (in px)
| minreducedwidth
| Minimum width of the plot with
| margin.automargin applied (in px)
| modebar
| :class:`plotly.graph_objects.layout.Modebar`
| instance or dict with compatible properties
| newselection
| :class:`plotly.graph_objects.layout.Newselectio
| n` instance or dict with compatible properties
| newshape
| :class:`plotly.graph_objects.layout.Newshape`
| instance or dict with compatible properties
| paper_bgcolor
| Sets the background color of the paper where
| the graph is drawn.
| piecolorway
| Sets the default pie slice colors. Defaults to
| the main `colorway` used for trace colors. If
| you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendpiecolors`.
| plot_bgcolor
| Sets the background color of the plotting area
| in-between x and y axes.
| polar
| :class:`plotly.graph_objects.layout.Polar`
| instance or dict with compatible properties
| scattergap
| Sets the gap (in plot fraction) between scatter
| points of adjacent location coordinates.
| Defaults to `bargap`.
| scattermode
| Determines how scatter points at the same
| location coordinate are displayed on the graph.
| With "group", the scatter points are plotted
| next to one another centered around the shared
| location. With "overlay", the scatter points
| are plotted over one another, you might need to
| reduce "opacity" to see multiple scatter
| points.
| scene
| :class:`plotly.graph_objects.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.
| selectionrevision
| Controls persistence of user-driven changes in
| selected points from all traces.
| selections
| A tuple of
| :class:`plotly.graph_objects.layout.Selection`
| instances or dicts with compatible properties
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets
| the default property values to use for elements
| of layout.selections
| 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
| A tuple of
| :class:`plotly.graph_objects.layout.Shape`
| instances or dicts with compatible properties
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the
| default property values to use for elements of
| layout.shapes
| showlegend
| Determines whether or not a legend is drawn.
| Default is `true` if there is a trace to show
| and any of these: a) Two or more traces would
| by default be shown in the legend. b) One pie
| trace is shown in the legend. c) One trace is
| explicitly given with `showlegend: true`.
| sliders
| A tuple of
| :class:`plotly.graph_objects.layout.Slider`
| instances or dicts with compatible properties
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets
| the default property values to use for elements
| of layout.sliders
| smith
| :class:`plotly.graph_objects.layout.Smith`
| 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.
| sunburstcolorway
| Sets the default sunburst slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendsunburstcolors`.
| template
| Default attributes to be applied to the plot.
| This should be a dict with format: `{'layout':
| layoutTemplate, 'data': {trace_type:
| [traceTemplate, ...], ...}}` where
| `layoutTemplate` is a dict matching the
| structure of `figure.layout` and
| `traceTemplate` is a dict matching the
| structure of the trace with type `trace_type`
| (e.g. 'scatter'). Alternatively, this may be
| specified as an instance of
| plotly.graph_objs.layout.Template. Trace
| templates are applied cyclically to traces of
| each type. Container arrays (eg `annotations`)
| have special handling: An object ending in
| `defaults` (eg `annotationdefaults`) is applied
| to each array item. But if an item has a
| `templateitemname` key we look in the template
| array for an item with matching `name` and
| apply that instead. If no matching `name` is
| found we mark the item invisible. Any named
| template item not referenced is appended to the
| end of the array, so this can be used to add a
| watermark annotation or a logo image, for
| example. To omit one of these items on the
| plot, make an item with matching
| `templateitemname` and `visible: false`.
| ternary
| :class:`plotly.graph_objects.layout.Ternary`
| instance or dict with compatible properties
| title
| :class:`plotly.graph_objects.layout.Title`
| instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.title.font
| instead. Sets the title font. Note that the
| title's font used to be customized by the now
| deprecated `titlefont` attribute.
| transition
| Sets transition options used during
| Plotly.react updates.
| treemapcolorway
| Sets the default treemap slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendtreemapcolors`.
| uirevision
| Used to allow user interactions with the plot
| to persist after `Plotly.react` calls that are
| unaware of these interactions. If `uirevision`
| is omitted, or if it is given and it changed
| from the previous `Plotly.react` call, the
| exact new figure is used. If `uirevision` is
| truthy and did NOT change, any attribute that
| has been affected by user interactions and did
| not receive a different value in the new figure
| will keep the interaction value.
| `layout.uirevision` attribute serves as the
| default for `uirevision` attributes in various
| sub-containers. For finer control you can set
| these sub-attributes directly. For example, if
| your app separately controls the data on the x
| and y axes you might set
| `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y
| data is changed, you can update
| `yaxis.uirevision=*quantity*` and the y axis
| range will reset but the x axis range will
| retain any user-driven zoom.
| uniformtext
| :class:`plotly.graph_objects.layout.Uniformtext
| ` instance or dict with compatible properties
| updatemenus
| A tuple of
| :class:`plotly.graph_objects.layout.Updatemenu`
| instances or dicts with compatible properties
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults),
| sets the default property values to use for
| elements of layout.updatemenus
| violingap
| Sets the gap (in plot fraction) between violins
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| violingroupgap
| Sets the gap (in plot fraction) between violins
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| violinmode
| Determines how violins at the same location
| coordinate are displayed on the graph. If
| "group", the violins are plotted next to one
| another centered around the shared location. If
| "overlay", the violins are plotted over one
| another, you might need to set "opacity" to see
| them multiple violins. Has no effect on traces
| that have "width" set.
| waterfallgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| waterfallmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "group", the bars are plotted next to one
| another centered around the shared location.
| With "overlay", the bars are plotted over one
| another, you might need to reduce "opacity" to
| see multiple bars.
| width
| Sets the plot's width (in px).
| xaxis
| :class:`plotly.graph_objects.layout.XAxis`
| instance or dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.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
|
| skip_invalid: bool
| If True, invalid properties in the figure specification will be
| skipped silently. If False (default) invalid properties in the
| figure specification will result in a ValueError
|
| Raises
| ------
| ValueError
| if a property in the specification of data, layout, or frames
| is invalid AND skip_invalid is False
|
| add_annotation(self, arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new annotation to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Annotation or dict with compatible
| properties
| align
| Sets the horizontal alignment of the `text` within the
| box. Has an effect only if `text` spans two or more
| lines (i.e. `text` contains one or more <br> HTML tags)
| or if an explicit width is set to override the text
| width.
| arrowcolor
| Sets the color of the annotation arrow.
| arrowhead
| Sets the end annotation arrow head style.
| arrowside
| Sets the annotation arrow head position.
| arrowsize
| Sets the size of the end annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| arrowwidth
| Sets the width (in px) of annotation arrow line.
| ax
| Sets the x component of the arrow tail about the arrow
| head. If `axref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from right
| to left (left to right). If `axref` is not `pixel` and
| is exactly the same as `xref`, this is an absolute
| value on that axis, like `x`, specified in the same
| coordinates as `xref`.
| axref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a x axis id
| (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis. In order for absolute
| positioning of the arrow to work, "axref" must be
| exactly the same as "xref", otherwise "axref" will
| revert to "pixel" (explained next). For relative
| positioning, "axref" can be set to "pixel", in which
| case the "ax" value is specified in pixels relative to
| "x". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| ay
| Sets the y component of the arrow tail about the arrow
| head. If `ayref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from bottom
| to top (top to bottom). If `ayref` is not `pixel` and
| is exactly the same as `yref`, this is an absolute
| value on that axis, like `y`, specified in the same
| coordinates as `yref`.
| ayref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a y axis id
| (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis. In order for absolute
| positioning of the arrow to work, "ayref" must be
| exactly the same as "yref", otherwise "ayref" will
| revert to "pixel" (explained next). For relative
| positioning, "ayref" can be set to "pixel", in which
| case the "ay" value is specified in pixels relative to
| "y". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| bgcolor
| Sets the background color of the annotation.
| bordercolor
| Sets the color of the border enclosing the annotation
| `text`.
| borderpad
| Sets the padding (in px) between the `text` and the
| enclosing border.
| borderwidth
| Sets the width (in px) of the border enclosing the
| annotation `text`.
| captureevents
| Determines whether the annotation text box captures
| mouse move and click events, or allows those events to
| pass through to data points in the plot that may be
| behind the annotation. By default `captureevents` is
| False unless `hovertext` is provided. If you use the
| event `plotly_clickannotation` without `hovertext` you
| must explicitly enable `captureevents`.
| clicktoshow
| Makes this annotation respond to clicks on the plot. If
| you click a data point that exactly matches the `x` and
| `y` values of this annotation, and it is hidden
| (visible: false), it will appear. In "onoff" mode, you
| must click the same point again to make it disappear,
| so if you click multiple points, you can show multiple
| annotations. In "onout" mode, a click anywhere else in
| the plot (on another data point or not) will hide this
| annotation. If you need to show/hide this annotation in
| response to different `x` or `y` values, you can set
| `xclick` and/or `yclick`. This is useful for example to
| label the side of a bar. To label markers though,
| `standoff` is preferred over `xclick` and `yclick`.
| font
| Sets the annotation text font.
| height
| Sets an explicit height for the text box. null
| (default) lets the text set the box height. Taller text
| will be clipped.
| hoverlabel
| :class:`plotly.graph_objects.layout.annotation.Hoverlab
| el` instance or dict with compatible properties
| hovertext
| Sets text to appear when hovering over this annotation.
| If omitted or blank, no hover label will appear.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the annotation (text + arrow).
| showarrow
| Determines whether or not the annotation is drawn with
| an arrow. If True, `text` is placed near the arrow's
| tail. If False, `text` lines up with the `x` and `y`
| provided.
| standoff
| Sets a distance, in pixels, to move the end arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| startarrowhead
| Sets the start annotation arrow head style.
| startarrowsize
| Sets the size of the start annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| startstandoff
| Sets a distance, in pixels, to move the start arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| text
| Sets the text associated with this annotation. Plotly
| uses a subset of HTML tags to do things like newline
| (<br>), bold (<b></b>), italics (<i></i>), hyperlinks
| (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>
| <span> are also supported.
| textangle
| Sets the angle at which the `text` is drawn with
| respect to the horizontal.
| valign
| Sets the vertical alignment of the `text` within the
| box. Has an effect only if an explicit height is set to
| override the text height.
| visible
| Determines whether or not this annotation is visible.
| width
| Sets an explicit width for the text box. null (default)
| lets the text set the box width. Wider text will be
| clipped. There is no automatic wrapping; use <br> to
| start a new line.
| x
| Sets the annotation's x position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| xanchor
| Sets the text box's horizontal position anchor This
| anchor binds the `x` position to the "left", "center"
| or "right" of the annotation. For example, if `x` is
| set to 1, `xref` to "paper" and `xanchor` to "right"
| then the right-most portion of the annotation lines up
| with the right-most edge of the plotting area. If
| "auto", the anchor is equivalent to "center" for data-
| referenced annotations or if there is an arrow, whereas
| for paper-referenced with no arrow, the anchor picked
| corresponds to the closest side.
| xclick
| Toggle this annotation when clicking a data point whose
| `x` value is `xclick` rather than the annotation's `x`
| value.
| xref
| Sets the annotation's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xshift
| Shifts the position of the whole annotation and arrow
| to the right (positive) or left (negative) by this many
| pixels.
| y
| Sets the annotation's y position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| yanchor
| Sets the text box's vertical position anchor This
| anchor binds the `y` position to the "top", "middle" or
| "bottom" of the annotation. For example, if `y` is set
| to 1, `yref` to "paper" and `yanchor` to "top" then the
| top-most portion of the annotation lines up with the
| top-most edge of the plotting area. If "auto", the
| anchor is equivalent to "middle" for data-referenced
| annotations or if there is an arrow, whereas for paper-
| referenced with no arrow, the anchor picked corresponds
| to the closest side.
| yclick
| Toggle this annotation when clicking a data point whose
| `y` value is `yclick` rather than the annotation's `y`
| value.
| yref
| Sets the annotation's y coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| yshift
| Shifts the position of the whole annotation and arrow
| up (positive) or down (negative) by this many pixels.
| row
| Subplot row for annotation. If 'all', addresses all
| rows in the specified column(s).
| col
| Subplot column for annotation. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add annotation to secondary y-axis
| exclude_empty_subplots
| If True, annotation will not be added to subplots
| without traces.
|
| Returns
| -------
| Figure
|
| add_bar(self, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Bar trace
|
| The data visualized by the span of the bars is set in `y` if
| `orientation` is set to "v" (the default) and the labels are
| set in `x`. By setting `orientation` to "h", the roles are
| interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units). In "stack" or "relative" barmode, traces that
| set "base" will be excluded and drawn in "overlay" mode
| instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.bar.ErrorX` instance or
| dict with compatible properties
| error_y
| :class:`plotly.graph_objects.bar.ErrorY` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.bar.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`. Anything contained in
| tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.bar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.bar.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.bar.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.bar.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.bar.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_barpolar(self, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Barpolar trace
|
| The data visualized by the radial span of the bars is set in
| `r`
|
| Parameters
| ----------
| base
| Sets where the bar base is drawn (in radial axis
| units). In "stack" barmode, traces that set "base" will
| be excluded and drawn in "overlay" mode instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.barpolar.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.barpolar.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.barpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.barpolar.Stream` instance
| or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.barpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar angular width (in "thetaunit" units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_box(self, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Box trace
|
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2, i.e. the median) is marked by a line
| inside the box. The fences grow outward from the boxes' edges,
| by default they span +/- 1.5 times the interquartile range
| (IQR: Q3-Q1), The sample mean and standard deviation as well as
| notches and the sample, outlier and suspected outliers points
| can be optionally added to the box plot. The values and
| positions corresponding to each boxes can be input using two
| signatures. The first signature expects users to supply the
| sample values in the `y` data array for vertical boxes (`x` for
| horizontal boxes). By supplying an `x` (`y`) array, one box per
| distinct `x` (`y`) value is drawn If no `x` (`y`) list is
| provided, a single box is drawn. In this case, the box is
| positioned with the trace `name` or with `x0` (`y0`) if
| provided. The second signature expects users to supply the
| boxes corresponding Q1, median and Q3 statistics in the `q1`,
| `median` and `q3` data arrays respectively. Other box features
| relying on statistics namely `lowerfence`, `upperfence`,
| `notchspan` can be set directly by the users. To have plotly
| compute them or to show sample points besides the boxes, users
| can set the `y` data array for vertical boxes (`x` for
| horizontal boxes) to a 2D array with the outer length
| corresponding to the number of boxes in the traces and the
| inner length corresponding the sample size.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| boxmean
| If True, the mean of the box(es)' underlying
| distribution is drawn as a dashed line inside the
| box(es). If "sd" the standard deviation is also drawn.
| Defaults to True when `mean` is set. Defaults to "sd"
| when `sd` is set Otherwise defaults to False.
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the box(es) are shown with no sample
| points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set. Defaults to "all" under the q1/median/q3
| signature. Otherwise defaults to "outliers".
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step for multi-box traces set
| using q1/median/q3.
| dy
| Sets the y coordinate step for multi-box traces set
| using q1/median/q3.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.box.Hoverlabel` instance
| or dict with compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the box(es).
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.box.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.box.Line` instance or dict
| with compatible properties
| lowerfence
| Sets the lower fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `lowerfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the lower as the last sample
| point below 1.5 times the IQR.
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
| marker
| :class:`plotly.graph_objects.box.Marker` instance or
| dict with compatible properties
| mean
| Sets the mean values. There should be as many items as
| the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `mean` is not
| provided but a sample (in `y` or `x`) is set, we
| compute the mean for each box using the sample values.
| meansrc
| Sets the source reference on Chart Studio Cloud for
| `mean`.
| median
| Sets the median values. There should be as many items
| as the number of boxes desired.
| mediansrc
| Sets the source reference on Chart Studio Cloud for
| `median`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For box traces, the name will
| also be used for the position coordinate, if `x` and
| `x0` (`y` and `y0` if horizontal) are missing and the
| position axis is categorical
| notched
| Determines whether or not notches are drawn. Notches
| displays a confidence interval around the median. We
| compute the confidence interval as median +/- 1.57 *
| IQR / sqrt(N), where IQR is the interquartile range and
| N is the sample size. If two boxes' notches do not
| overlap there is 95% confidence their medians differ.
| See https://sites.google.com/site/davidsstatistics/home
| /notched-box-plots for more info. Defaults to False
| unless `notchwidth` or `notchspan` is set.
| notchspan
| Sets the notch span from the boxes' `median` values.
| There should be as many items as the number of boxes
| desired. This attribute has effect only under the
| q1/median/q3 signature. If `notchspan` is not provided
| but a sample (in `y` or `x`) is set, we compute it as
| 1.57 * IQR / sqrt(N), where N is the sample size.
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
| notchwidth
| Sets the width of the notches relative to the box'
| width. For example, with 0, the notches are as wide as
| the box(es).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the box(es). If 0, the sample points are places over
| the center of the box(es). Positive (negative) values
| correspond to positions to the right (left) for
| vertical boxes and above (below) for horizontal boxes
| q1
| Sets the Quartile 1 values. There should be as many
| items as the number of boxes desired.
| q1src
| Sets the source reference on Chart Studio Cloud for
| `q1`.
| q3
| Sets the Quartile 3 values. There should be as many
| items as the number of boxes desired.
| q3src
| Sets the source reference on Chart Studio Cloud for
| `q3`.
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| sd
| Sets the standard deviation values. There should be as
| many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3
| signature. If `sd` is not provided but a sample (in `y`
| or `x`) is set, we compute the standard deviation for
| each box using the sample values.
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to
| be drawn across any stddev range For example 1-stddev,
| 3-stddev, 5-stddev
| sdsrc
| Sets the source reference on Chart Studio Cloud for
| `sd`.
| selected
| :class:`plotly.graph_objects.box.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showwhiskers
| Determines whether or not whiskers are visible.
| Defaults to true for `sizemode` "quartiles", false for
| "sd".
| sizemode
| Sets the upper and lower bound for the boxes quartiles
| means box is drawn between Q1 and Q3 SD means the box
| is drawn between Mean +- Standard Deviation Argument
| sdmultiple (default 1) to scale the box size So it
| could be drawn 1-stddev, 3-stddev etc
| stream
| :class:`plotly.graph_objects.box.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.box.Unselected` instance
| or dict with compatible properties
| upperfence
| Sets the upper fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `upperfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the upper as the last sample
| point above 1.5 times the IQR.
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| width
| Sets the width of the box in data coordinate If 0
| (default value) the width is automatically selected
| based on the positions of other box traces in the same
| subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_candlestick(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Candlestick trace
|
| The candlestick is a style of financial chart describing open,
| high, low and close for a given `x` coordinate (most likely
| time). The boxes represent the spread between the `open` and
| `close` values and the lines represent the spread between the
| `low` and `high` values Sample points where the close value is
| higher (lower) then the open value are called increasing
| (decreasing). By default, increasing candles are drawn in green
| whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.candlestick.Decreasing`
| instance or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.candlestick.Hoverlabel`
| instance or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.candlestick.Increasing`
| instance or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.candlestick.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.candlestick.Line` instance
| or dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.candlestick.Stream`
| instance or dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| 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, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Carpet trace
|
| The data describing carpet axis layout is set in `y` and
| (optionally) also `x`. If only `y` is present, `x` the plot is
| interpreted as a cheater plot and is filled in using the `y`
| values. `x` and `y` may either be 2D arrays matching with each
| dimension matching that of `a` and `b`, or they may be 1D
| arrays with total length equal to that of `a` and `b`.
|
| Parameters
| ----------
| a
| An array containing values of the first parameter value
| a0
| Alternate to `a`. Builds a linear space of a
| coordinates. Use with `da` where `a0` is the starting
| coordinate and `da` the step.
| aaxis
| :class:`plotly.graph_objects.carpet.Aaxis` instance or
| dict with compatible properties
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| A two dimensional array of y coordinates at each carpet
| point.
| b0
| Alternate to `b`. Builds a linear space of a
| coordinates. Use with `db` where `b0` is the starting
| coordinate and `db` the step.
| baxis
| :class:`plotly.graph_objects.carpet.Baxis` instance or
| dict with compatible properties
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| cheaterslope
| The shift applied to each successive row of data in
| creating a cheater plot. Only used if `x` is been
| omitted.
| color
| Sets default for all colors associated with this axis
| all at once: line, font, tick, and grid colors. Grid
| color is lightened by blending this with the plot
| background Individual pieces can override this.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the a coordinate step. See `a0` for more info.
| db
| Sets the b coordinate step. See `b0` for more info.
| font
| The default font used for axis & tick labels on this
| carpet
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.carpet.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| stream
| :class:`plotly.graph_objects.carpet.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| A two dimensional array of x coordinates at each carpet
| point. If omitted, the plot is a cheater plot and the
| xaxis is hidden by default.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| A two dimensional array of y coordinates at each carpet
| point.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_choropleth(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Choropleth trace
|
| The data that describes the choropleth value-to-color mapping
| is set in `z`. The geographic locations corresponding to each
| value in `z` are set in `locations`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choropleth.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choropleth.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choropleth.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choropleth.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choropleth.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choropleth.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choropleth.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_choroplethmap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Choroplethmap trace
|
| GeoJSON features to be filled are set in `geojson` The data
| that describes the choropleth value-to-color mapping is set in
| `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmap traces are placed above the water layers.
| If set to '', the layer will be inserted above every
| existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmap.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_choroplethmapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Choroplethmapbox trace
|
| "choroplethmapbox" trace is deprecated! Please consider
| switching to the "choroplethmap" trace type and `map` subplots.
| Learn more at: https://plotly.com/javascript/maplibre-
| migration/ GeoJSON features to be filled are set in `geojson`
| The data that describes the choropleth value-to-color mapping
| is set in `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmapbox traces are placed above the water
| layers. If set to '', the layer will be inserted above
| every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
| l` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmapbox.Legendgro
| uptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmapbox.Unselecte
| d` instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_cone(self, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Cone trace
|
| Use cone traces to visualize vector fields. Specify a vector
| field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and
| 3 vector component arrays `u`, `v`, `w`. The cones are drawn
| exactly at the positions given by `x`, `y` and `z`.
|
| Parameters
| ----------
| anchor
| Sets the cones' anchor with respect to their x/y/z
| positions. Note that "cm" denote the cone's center of
| mass which corresponds to 1/4 from the tail to tip.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.cone.ColorBar` instance or
| dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.cone.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `norm` Anything contained in tag `<extra>`
| is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.cone.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.cone.Lighting` instance or
| dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.cone.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in
| the vector field) or as "absolute" value (in the same
| units as the vector field). To display sizes in actual
| vector length use "raw".
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally)
| corresponds to the minimum "time" to travel across two
| successive x/y/z positions at the average velocity of
| those two successive positions. All cones in a given
| trace use the same factor. With `sizemode` set to
| "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is
| 0.5. With `sizemode` set to "absolute", `sizeref` has
| the same units as the u/v/w vector field, its the
| default value is half the sample's maximum vector norm.
| stream
| :class:`plotly.graph_objects.cone.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the cones. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_contour(self, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Contour trace
|
| The data from which contour lines are computed is set in `z`.
| Data in `z` must be a 2D list of numbers. Say that `z` has N
| rows and M columns, then by default, these N rows correspond to
| N y coordinates (set in `y` or auto-generated) and the M
| columns correspond to M x coordinates (set in `x` or auto-
| generated). By setting `transpose` to True, the above behavior
| is flipped.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contour.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array otherwise it
| is defaulted to false.
| contours
| :class:`plotly.graph_objects.contour.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.contour.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contour.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contour.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contour.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| 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, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Contourcarpet trace
|
| Plots contours on either the first carpet axis or the carpet
| axis with a matching `carpet` attribute. Data `z` is
| interpreted as matching that of the corresponding carpet axis.
|
| Parameters
| ----------
| a
| Sets the x coordinates.
| a0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| atype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| b
| Sets the y coordinates.
| b0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| btype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| carpet
| The `carpet` of the carpet axes on which this contour
| trace lies
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contourcarpet.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.contourcarpet.Contours`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the x coordinate step. See `x0` for more info.
| db
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contourcarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contourcarpet.Line`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contourcarpet.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_densitymap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Densitymap trace
|
| Draws a bivariate kernel density estimation with a Gaussian
| kernel from `lon` and `lat` coordinates and optional `z` values
| using a colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymap trace will be inserted
| before the layer with the specified ID. By default,
| densitymap traces are placed below the first layer of
| type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymap
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_densitymapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Densitymapbox trace
|
| "densitymapbox" trace is deprecated! Please consider switching
| to the "densitymap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ Draws a
| bivariate kernel density estimation with a Gaussian kernel from
| `lon` and `lat` coordinates and optional `z` values using a
| colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymapbox trace will be inserted
| before the layer with the specified ID. By default,
| densitymapbox traces are placed below the first layer
| of type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymapbox
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_funnel(self, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Funnel trace
|
| Visualize stages in a process using length-encoded bars. This
| trace can be used to show data in either a part-to-whole
| representation wherein each item appears in a single stage, or
| in a "drop-off" representation wherein each item appears in
| each stage it traversed. See also the "funnelarea" trace type
| for a different approach to visualizing funnel data.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.funnel.Connector` instance
| or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnel.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious` and
| `percentTotal`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnel.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnel.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the funnels. With "v" ("h"),
| the value of the each bar spans along the vertical
| (horizontal). By default funnels are tend to be
| oriented horizontally; unless only "y" array is
| presented or orientation is set to "v". Also regarding
| graphs including only 'horizontal' funnels, "autorange"
| on the "y-axis" are set to "reversed".
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnel.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple funnels, percentages &
| totals are computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious`,
| `percentTotal`, `label` and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_funnelarea(self, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Funnelarea trace
|
| Visualize stages in a process using area-encoded trapezoids.
| This trace can be used to show data in a part-to-whole
| representation similar to a "pie" trace, wherein each item
| appears in a single stage. See also the "funnel" trace type for
| a different approach to visualizing funnel data.
|
| Parameters
| ----------
| aspectratio
| Sets the ratio between height and width
| baseratio
| Sets the ratio between bottom length and maximum top
| length.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.funnelarea.Domain`
| instance or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnelarea.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnelarea.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnelarea.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnelarea.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.funnelarea.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_heatmap(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Heatmap trace
|
| The data that describes the heatmap value-to-color mapping is
| set in `z`. Data in `z` can either be a 2D list of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a 2D list, say that `z` has N rows and M columns. Then, by
| default, the resulting heatmap will have N partitions along the
| y axis and M partitions along the x axis. In other words, the
| i-th row/ j-th column cell in `z` is mapped to the i-th
| partition of the y axis (starting from the bottom of the plot)
| and the j-th partition of the x-axis (starting from the left of
| the plot). This behavior can be flipped by using `transpose`.
| Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1)
| elements. If M (N), then the coordinates correspond to the
| center of the heatmap cells and the cells have equal width. If
| M+1 (N+1), then the coordinates correspond to the edges of the
| heatmap cells. In the case where `z` is a 1D list, the x and y
| coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmap.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array and `zsmooth`
| is not false; otherwise it is defaulted to false.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmap.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmap.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_heatmapgl(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Heatmapgl trace
|
| "heatmapgl" trace is deprecated! Please consider switching to
| the "heatmap" or "image" trace types. Alternatively you could
| contribute/sponsor rewriting this trace type based on cartesian
| features and using regl framework. WebGL version of the heatmap
| trace type.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmapgl.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmapgl.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmapgl.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_histogram(self, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Histogram trace
|
| The sample data from which statistics are computed is set in
| `x` for vertically spanning histograms and in `y` for
| horizontally spanning histograms. Binning options are set
| `xbins` and `ybins` respectively if no aggregation data is
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| bingroup
| Set a group of histogram traces which will have
| compatible bin settings. Note that traces on the same
| subplot and with the same "orientation" under `barmode`
| "stack", "relative" and "group" are forced into the
| same bingroup, Using `bingroup`, traces under `barmode`
| "overlay" and on different axes (of the same axis type)
| can have compatible bin settings. Note that histogram
| and histogram2d* trace can share the same `bingroup`
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| cumulative
| :class:`plotly.graph_objects.histogram.Cumulative`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.histogram.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.histogram.ErrorY` instance
| or dict with compatible properties
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `binNumber` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.histogram.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.histogram.Stream` instance
| or dict with compatible properties
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the text font.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label` and `value`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.histogram.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbins
| :class:`plotly.graph_objects.histogram.XBins` instance
| or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybins
| :class:`plotly.graph_objects.histogram.YBins` instance
| or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_histogram2d(self, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Histogram2d trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a heatmap.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2d.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2d.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram2d.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2d.Stream`
| instance or dict with compatible properties
| textfont
| Sets the text font.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z`
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2d.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2d.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_histogram2dcontour(self, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Histogram2dContour trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a contour plot.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2dcontour.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.histogram2dcontour.Contour
| s` instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2dcontour.Hoverla
| bel` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2dcontour.Legendg
| rouptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.histogram2dcontour.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.histogram2dcontour.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2dcontour.Stream`
| instance or dict with compatible properties
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2dcontour.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2dcontour.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_hline(self, y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a horizontal line to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y: float or int
| A number representing the y coordinate of the horizontal line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_hrect(self, y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a rectangle to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y0: float or int
| A number representing the y coordinate of one side of the rectangle.
| y1: float or int
| A number representing the y coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_icicle(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Icicle trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The icicle sectors are determined
| by the entries in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.icicle.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.icicle.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.icicle.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.icicle.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.icicle.Marker` instance or
| dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.icicle.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.icicle.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.icicle.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.icicle.Tiling` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_image(self, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Image trace
|
| Display an image, i.e. data on a 2D regular raster. By default,
| when an image is displayed in a subplot, its y axis will be
| reversed (ie. `autorange: 'reversed'`), constrained to the
| domain (ie. `constrain: 'domain'`) and it will have the same
| scale as its x axis (ie. `scaleanchor: 'x,`) in order for
| pixels to be rendered as squares.
|
| Parameters
| ----------
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified,
| this attribute will be set to `rgba256` otherwise it
| defaults to `rgb`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Set the pixel's horizontal size.
| dy
| Set the pixel's vertical size
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.image.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `z`, `color` and `colormodel`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.image.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| source
| Specifies the data URI of the image to be visualized.
| The URI consists of "data:image/[<media
| subtype>][;base64],<data>"
| stream
| :class:`plotly.graph_objects.image.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Set the image's x position. The left edge of the image
| (or the right edge if the x axis is reversed or dx is
| negative) will be found at xmin=x0-dx/2
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| y0
| Set the image's y position. The top edge of the image
| (or the bottom edge if the y axis is NOT reversed or if
| dy is negative) will be found at ymin=y0-dy/2. By
| default when an image trace is included, the y axis
| will be reversed so that the image is right-side-up,
| but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis
| range.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| A 2-dimensional array in which each element is an array
| of 3 or 4 numbers representing a color.
| zmax
| Array defining the higher bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [255,
| 255, 255]. For the `rgba` colormodel, it is [255, 255,
| 255, 1]. For the `rgba256` colormodel, it is [255, 255,
| 255, 255]. For the `hsl` colormodel, it is [360, 100,
| 100]. For the `hsla` colormodel, it is [360, 100, 100,
| 1].
| zmin
| Array defining the lower bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [0, 0,
| 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For
| the `rgba256` colormodel, it is [0, 0, 0, 0]. For the
| `hsl` colormodel, it is [0, 0, 0]. For the `hsla`
| colormodel, it is [0, 0, 0, 0].
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data.
| This only applies for image traces that use the
| `source` attribute.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_indicator(self, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Indicator trace
|
| An indicator is used to visualize a single `value` along with
| some contextual information such as `steps` or a `threshold`,
| using a combination of three visual elements: a number, a
| delta, and/or a gauge. Deltas are taken with respect to a
| `reference`. Gauges can be either angular or bullet (aka
| linear) gauges.
|
| Parameters
| ----------
| align
| Sets the horizontal alignment of the `text` within the
| box. Note that this attribute has no effect if an
| angular gauge is displayed: in this case, it is always
| centered
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delta
| :class:`plotly.graph_objects.indicator.Delta` instance
| or dict with compatible properties
| domain
| :class:`plotly.graph_objects.indicator.Domain` instance
| or dict with compatible properties
| gauge
| The gauge of the Indicator plot.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.indicator.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines how the value is displayed on the graph.
| `number` displays the value numerically in text.
| `delta` displays the difference to a reference value in
| text. Finally, `gauge` displays the value graphically
| on an axis.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| number
| :class:`plotly.graph_objects.indicator.Number` instance
| or dict with compatible properties
| stream
| :class:`plotly.graph_objects.indicator.Stream` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.indicator.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the number to be displayed.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_isosurface(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Isosurface trace
|
| Draws isosurfaces between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.isosurface.Caps` instance
| or dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.isosurface.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.isosurface.Contour`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.isosurface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.isosurface.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.isosurface.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.isosurface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.isosurface.Slices`
| instance or dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.isosurface.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.isosurface.Stream`
| instance or dict with compatible properties
| surface
| :class:`plotly.graph_objects.isosurface.Surface`
| instance or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_layout_image(self, arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new image to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Image or dict with compatible properties
| layer
| Specifies whether images are drawn below or above
| traces. When `xref` and `yref` are both set to `paper`,
| image is drawn below the entire plot area.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the image.
| sizex
| Sets the image container size horizontally. The image
| will be sized based on the `position` value. When
| `xref` is set to `paper`, units are sized relative to
| the plot width. When `xref` ends with ` domain`, units
| are sized relative to the axis width.
| sizey
| Sets the image container size vertically. The image
| will be sized based on the `position` value. When
| `yref` is set to `paper`, units are sized relative to
| the plot height. When `yref` ends with ` domain`, units
| are sized relative to the axis height.
| sizing
| Specifies which dimension of the image to constrain.
| source
| Specifies the URL of the image to be used. The URL must
| be accessible from the domain where the plot code is
| run, and can be either relative or absolute.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| visible
| Determines whether or not this image is visible.
| x
| Sets the image's x position. When `xref` is set to
| `paper`, units are sized relative to the plot height.
| See `xref` for more info
| xanchor
| Sets the anchor for the x position
| xref
| Sets the images's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y
| Sets the image's y position. When `yref` is set to
| `paper`, units are sized relative to the plot height.
| See `yref` for more info
| yanchor
| Sets the anchor for the y position.
| yref
| Sets the images's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for image. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for image. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add image to secondary y-axis
| exclude_empty_subplots
| If True, image will not be added to subplots without
| traces.
|
| Returns
| -------
| Figure
|
| add_mesh3d(self, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Mesh3d trace
|
| Draws sets of triangles with coordinates given by three
| 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`,
| `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-
| shape algorithm or (4) the Convex-hull algorithm
|
| Parameters
| ----------
| alphahull
| Determines how the mesh surface triangles are derived
| from the set of vertices (points) represented by the
| `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays
| are not supplied. For general use of `mesh3d` it is
| preferred that `i`, `j`, `k` are supplied. If "-1",
| Delaunay triangulation is used, which is mainly
| suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In
| case the `delaunayaxis` intersects the mesh surface at
| more than one point it will result triangles that are
| very long in the dimension of `delaunayaxis`. If ">0",
| the alpha-shape algorithm is used. In this case, the
| positive `alphahull` value signals the use of the
| alpha-shape algorithm, _and_ its value acts as the
| parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or
| if the intention is to enclose the `x`, `y` and `z`
| point set into a convex hull.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `intensity`) or
| the bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `intensity`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmax`
| must be set as well.
| color
| Sets the color of the whole mesh
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.mesh3d.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.mesh3d.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is
| perpendicular to the surface of the Delaunay
| triangulation. It has an effect if `i`, `j`, `k` are
| not provided and `alphahull` is set to indicate
| Delaunay triangulation.
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.mesh3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| i
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "first" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `i[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `i` represents a point in space, which
| is the first vertex of a triangle.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| intensity
| Sets the intensity values for vertices or cells as
| defined by `intensitymode`. It can be used for plotting
| fields on meshes.
| intensitymode
| Determines the source of `intensity` values.
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
| isrc
| Sets the source reference on Chart Studio Cloud for
| `i`.
| j
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "second" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `j[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `j` represents a point in space, which
| is the second vertex of a triangle.
| jsrc
| Sets the source reference on Chart Studio Cloud for
| `j`.
| k
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "third" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `k[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `k` represents a point in space, which
| is the third vertex of a triangle.
| ksrc
| Sets the source reference on Chart Studio Cloud for
| `k`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.mesh3d.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.mesh3d.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.mesh3d.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.mesh3d.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| vertexcolor
| Sets the color of each vertex Overrides "color". While
| Red, green and blue colors are in the range of 0 and
| 255; in the case of having vertex color data in RGBA
| format, the alpha color should be normalized to be
| between 0 and 1.
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_ohlc(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Ohlc trace
|
| The ohlc (short for Open-High-Low-Close) is a style of
| financial chart describing open, high, low and close for a
| given `x` coordinate (most likely time). The tip of the lines
| represent the `low` and `high` values and the horizontal
| segments represent the `open` and `close` values. Sample points
| where the close value is higher (lower) then the open value are
| called increasing (decreasing). By default, increasing items
| are drawn in green whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.ohlc.Decreasing` instance
| or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.ohlc.Hoverlabel` instance
| or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.ohlc.Increasing` instance
| or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.ohlc.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.ohlc.Line` instance or
| dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.ohlc.Stream` instance or
| dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| tickwidth
| Sets the width of the open/close tick marks relative to
| the "x" minimal interval.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_parcats(self, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Parcats trace
|
| Parallel categories diagram for multidimensional categorical
| data.
|
| Parameters
| ----------
| arrangement
| Sets the drag interaction mode for categories and
| dimensions. If `perpendicular`, the categories can only
| move along a line perpendicular to the paths. If
| `freeform`, the categories can freely move on the
| plane. If `fixed`, the categories and dimensions are
| stationary.
| bundlecolors
| Sort paths so that like colors are bundled together
| within each category.
| counts
| The number of observations represented by each state.
| Defaults to 1 so that each state represents one
| observation
| countssrc
| Sets the source reference on Chart Studio Cloud for
| `counts`.
| dimensions
| The dimensions (variables) of the parallel categories
| diagram.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets
| the default property values to use for elements of
| parcats.dimensions
| domain
| :class:`plotly.graph_objects.parcats.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoveron
| Sets the hover interaction mode for the parcats
| diagram. If `category`, hover interaction take place
| per category. If `color`, hover interactions take place
| per color per category. If `dimension`, hover
| interactions take place across all categories per
| dimension.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. This value here applies when hovering
| over dimensions. Note that `*categorycount`,
| "colorcount" and "bandcolorcount" are only available
| when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`,
| `probability`, `category`, `categorycount`,
| `colorcount` and `bandcolorcount`. Anything contained
| in tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| labelfont
| Sets the font for the `dimension` labels.
| legendgrouptitle
| :class:`plotly.graph_objects.parcats.Legendgrouptitle`
| instance or dict with compatible properties
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcats.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort
| paths based on dimension categories from left to right.
| If `backward`, sort paths based on dimensions
| categories from right to left.
| stream
| :class:`plotly.graph_objects.parcats.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `category` labels.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_parcoords(self, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Parcoords trace
|
| Parallel coordinates for multidimensional exploratory data
| analysis. The samples are specified in `dimensions`. The colors
| are set in `line.color`.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets
| the default property values to use for elements of
| parcoords.dimensions
| domain
| :class:`plotly.graph_objects.parcoords.Domain` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| labelangle
| Sets the angle of the labels with respect to the
| horizontal. For example, a `tickangle` of -90 draws the
| labels vertically. Tilted labels with "labelangle" may
| be positioned better inside margins when
| `labelposition` is set to "bottom".
| labelfont
| Sets the font for the `dimension` labels.
| labelside
| Specifies the location of the `label`. "top" positions
| labels above, next to the title "bottom" positions
| labels below the graph Tilted labels with "labelangle"
| may be positioned better inside margins when
| `labelposition` is set to "bottom".
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.parcoords.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcoords.Line` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| rangefont
| Sets the font for the `dimension` range values.
| stream
| :class:`plotly.graph_objects.parcoords.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.parcoords.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_pie(self, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Pie trace
|
| A data visualized by the sectors of the pie is set in `values`.
| The sector labels are set in `labels`. The sector colors are
| set in `marker.colors`
|
| Parameters
| ----------
| automargin
| Determines whether outside text labels can push the
| margins.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| direction
| Specifies the direction at which succeeding sectors
| follow one another.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.pie.Domain` instance or
| dict with compatible properties
| hole
| Sets the fraction of the radius to cut out of the pie.
| Use this to make a donut chart.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pie.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pie.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pie.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector.
| pull
| Sets the fraction of larger radius to pull the sectors
| out from the center. This can be a constant to pull all
| slices apart from each other equally or an array to
| highlight one or more slices.
| pullsrc
| Sets the source reference on Chart Studio Cloud for
| `pull`.
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pie charts that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.pie.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.pie.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the
| font used for `title`. Note that the title's font used
| to be set by the now deprecated `titlefont` attribute.
| titleposition
| Deprecated: Please use pie.title.position instead.
| Specifies the location of the `title`. Note that the
| title's position used to be set by the now deprecated
| `titleposition` attribute.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_pointcloud(self, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Pointcloud trace
|
| "pointcloud" trace is deprecated! Please consider switching to
| the "scattergl" trace type. The data visualized as a point
| cloud set in `x` and `y` using the WebGl plotting engine.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pointcloud.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| indices
| A sequential value, 0..n, supply it to avoid creating
| this array inside plotting. If specified, it must be a
| typed `Int32Array` array. Its length must be equal to
| or greater than the number of points. For the best
| performance and memory use, create one large `indices`
| typed array that is guaranteed to be at least as long
| as the largest number of points during use, and reuse
| it on each `Plotly.restyle()` call.
| indicessrc
| Sets the source reference on Chart Studio Cloud for
| `indices`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pointcloud.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pointcloud.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.pointcloud.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `ybounds` for the performance
| benefits.
| xboundssrc
| Sets the source reference on Chart Studio Cloud for
| `xbounds`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xy
| Faster alternative to specifying `x` and `y`
| separately. If supplied, it must be a typed
| `Float32Array` array that represents points such that
| `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`
| xysrc
| Sets the source reference on Chart Studio Cloud for
| `xy`.
| y
| Sets the y coordinates.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `xbounds` for the performance
| benefits.
| yboundssrc
| Sets the source reference on Chart Studio Cloud for
| `ybounds`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_sankey(self, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Sankey trace
|
| Sankey plots for network flow data analysis. The nodes are
| specified in `nodes` and the links between sources and targets
| in `links`. The colors are set in `nodes[i].color` and
| `links[i].color`, otherwise defaults are used.
|
| Parameters
| ----------
| arrangement
| If value is `snap` (the default), the node arrangement
| is assisted by automatic snapping of elements to
| preserve space between nodes specified via `nodepad`.
| If value is `perpendicular`, the nodes can only move
| along a line perpendicular to the flow. If value is
| `freeform`, the nodes can freely move on the plane. If
| value is `fixed`, the nodes are stationary.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sankey.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired. Note that this attribute is
| superseded by `node.hoverinfo` and `node.hoverinfo` for
| nodes and links respectively.
| hoverlabel
| :class:`plotly.graph_objects.sankey.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sankey.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| link
| The links of the Sankey plot.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| orientation
| Sets the orientation of the Sankey diagram.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| stream
| :class:`plotly.graph_objects.sankey.Stream` instance or
| dict with compatible properties
| textfont
| Sets the font for node labels
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| valuesuffix
| Adds a unit to follow the value in the hover tooltip.
| Add a space if a separation is necessary from the
| value.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scatter(self, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Scatter trace
|
| The scatter trace type encompasses line charts, scatter charts,
| text charts, and bubble charts. The data visualized as scatter
| point or lines is set in `x` and `y`. Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scatter.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available. If fillgradient is
| specified, fillcolor is ignored except for setting the
| background color of the hover label, if any.
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor
| is used instead.
| fillpattern
| Sets the pattern within the marker.
| groupnorm
| Only relevant when `stackgroup` is used, and only the
| first `groupnorm` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Sets the normalization for the sum of
| this `stackgroup`. With "fraction", the value of each
| trace at each location is divided by the sum of all
| trace values at that location. "percent" is the same
| but multiplied by 100 to show percentages. If there are
| multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Only relevant in the following cases: 1. when
| `scattermode` is set to "group". 2. when `stackgroup`
| is used, and only the first `orientation` found in the
| `stackgroup` will be used - including if `visible` is
| "legendonly" but not if it is `false`. Sets the
| stacking direction. With "v" ("h"), the y (x) values of
| subsequent traces are added. Also affects the default
| value of `fill`.
| selected
| :class:`plotly.graph_objects.scatter.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stackgaps
| Only relevant when `stackgroup` is used, and only the
| first `stackgaps` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Determines how we handle locations at
| which other traces in this group have data but this one
| does not. With *infer zero* we insert a zero at these
| locations. With "interpolate" we linearly interpolate
| between existing values, and extrapolate a constant
| beyond the existing values.
| stackgroup
| Set several scatter traces (on the same subplot) to the
| same stackgroup in order to add their y values (or
| their x values if `orientation` is "h"). If blank or
| omitted this trace will not be stacked. Stacking also
| turns `fill` on by default, using "tonexty" ("tonextx")
| if `orientation` is "h" ("v") and sets the default
| `mode` to "lines" irrespective of point count. You can
| only stack on a numeric (linear or log) axis. Traces in
| a `stackgroup` will only fill to (or be filled to)
| other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if
| fill-linked traces are not already consecutive, the
| later ones will be pushed down in the drawing order.
| stream
| :class:`plotly.graph_objects.scatter.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatter.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_scatter3d(self, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatter3d trace
|
| The data visualized as scatter point or lines in 3D dimension
| is set in `x`, `y`, `z`. Text (appearing either on the chart or
| on hover only) is via `text`. Bubble charts are achieved by
| setting `marker.size` and/or `marker.color` Projections are
| achieved via `projection`. Surface fills are achieved via
| `surfaceaxis`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.scatter3d.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter3d.ErrorY` instance
| or dict with compatible properties
| error_z
| :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter3d.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter3d.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| projection
| :class:`plotly.graph_objects.scatter3d.Projection`
| instance or dict with compatible properties
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatter3d.Stream` instance
| or dict with compatible properties
| surfaceaxis
| If "-1", the scatter points are not fill with a surface
| If 0, 1, 2, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Scattercarpet trace
|
| Plots a scatter trace on either the first carpet axis or the
| carpet axis with a matching `carpet` attribute.
|
| Parameters
| ----------
| a
| Sets the a-axis coordinates.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the b-axis coordinates.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattercarpet.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b). To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattercarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattercarpet.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattercarpet.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattercarpet.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattercarpet.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (a,b) point. If
| a single string, the same string appears over all the
| data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattercarpet.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_scattergeo(self, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattergeo trace
|
| The data visualized as scatter point or lines on a geographic
| map is provided either by longitude/latitude pairs in `lon` and
| `lat` respectively or by geographic location IDs or names in
| `locations`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used
| when `locations` is set. It can be set as a valid
| GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or
| "Feature" with geometries of type "Polygon" or
| "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergeo.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair or item in `locations`. If a single string, the
| same string appears over all the data points. If an
| array of string, the items are mapped in order to the
| this trace's (lon,lat) or `locations` coordinates. To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergeo.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergeo.Line` instance
| or dict with compatible properties
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names.
| Coordinates correspond to the centroid of each location
| given. See `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattergeo.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergeo.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergeo.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (lon,lat) pair
| or item in `locations`. If a single string, the same
| string appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (lon,lat) or `locations` coordinates. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is
| not set, these elements will be seen in the hover
| labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon`, `location` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergeo.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Scattergl trace
|
| The data visualized as scatter point or lines is set in `x` and
| `y` using the WebGL plotting engine. Bubble charts are achieved
| by setting `marker.size` and/or `marker.color` to a numerical
| arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scattergl.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scattergl.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergl.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattergl.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergl.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_scattermap(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattermap trace
|
| The data visualized as scatter point, lines or marker symbols
| on a MapLibre GL geographic map is provided by
| longitude/latitude pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermap trace's layers are to be
| inserted before the layer with the specified ID. By
| default, scattermap layers are inserted above all the
| base layers. To place the scattermap layers above every
| other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermap.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermap.Line` instance
| or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=map.layer.paint.text-
| color, size=map.layer.layout.text-size). Has an effect
| only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scattermapbox(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattermapbox trace
|
| "scattermapbox" trace is deprecated! Please consider switching
| to the "scattermap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ The data
| visualized as scatter point, lines or marker symbols on a
| Mapbox GL geographic map is provided by longitude/latitude
| pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermapbox trace's layers are to
| be inserted before the layer with the specified ID. By
| default, scattermapbox layers are inserted above all
| the base layers. To place the scattermapbox layers
| above every other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermapbox.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermapbox.Line`
| instance or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-
| color, size=mapbox.layer.layout.text-size). Has an
| effect only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermapbox.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scatterpolar(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatterpolar trace
|
| The scatterpolar trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in polar coordinates.
| The data visualized as scatter point or lines is set in `r`
| (radial) and `theta` (angular) coordinates Text (appearing
| either on the chart or on hover only) is via `text`. Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterpolar has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolar.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolar.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolar.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolar.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolar.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scatterpolargl(self, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatterpolargl trace
|
| The scatterpolargl trace type encompasses line charts, scatter
| charts, and bubble charts in polar coordinates using the WebGL
| plotting engine. The data visualized as scatter point or lines
| is set in `r` (radial) and `theta` (angular) coordinates Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolargl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolargl.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolargl.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolargl.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolargl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolargl.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolargl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scattersmith(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattersmith trace
|
| The scattersmith trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in smith coordinates.
| The data visualized as scatter point or lines is set in `real`
| and `imag` (imaginary) coordinates Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scattersmith has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattersmith.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| imagsrc
| Sets the source reference on Chart Studio Cloud for
| `imag`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattersmith.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattersmith.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattersmith.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| real
| Sets the real component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| realsrc
| Sets the source reference on Chart Studio Cloud for
| `real`.
| selected
| :class:`plotly.graph_objects.scattersmith.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattersmith.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a smith subplot. If "smith" (the default value),
| the data refer to `layout.smith`. If "smith2", the data
| refer to `layout.smith2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `real`, `imag` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattersmith.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatterternary trace
|
| Provides similar functionality to the "scatter" type but on a
| ternary phase diagram. The data is provided by at least two
| arrays out of `a`, `b`, `c` triplets.
|
| Parameters
| ----------
| a
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on Chart Studio Cloud for
| `c`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterternary.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b,c)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b,c).
| To be seen, trace `hoverinfo` must contain a "text"
| flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterternary.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterternary.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterternary.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scatterternary.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterternary.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If "ternary" (the default
| value), the data refer to `layout.ternary`. If
| "ternary2", the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b`, `c` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterternary.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_selection(self, arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new selection to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Selection or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.layout.selection.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the selection.
| path
| For `type` "path" - a valid SVG path similar to
| `shapes.path` in data coordinates. Allowed segments
| are: M, L and Z.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the selection type to be drawn. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom
| SVG path using `path`.
| x0
| Sets the selection's starting x position.
| x1
| Sets the selection's end x position.
| xref
| Sets the selection's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y0
| Sets the selection's starting y position.
| y1
| Sets the selection's end y position.
| yref
| Sets the selection's x coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for selection. If 'all', addresses all rows
| in the specified column(s).
| col
| Subplot column for selection. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add selection to secondary y-axis
| exclude_empty_subplots
| If True, selection will not be added to subplots
| without traces.
|
| Returns
| -------
| Figure
|
| add_shape(self, arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new shape to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Shape or dict with compatible properties
| editable
| Determines whether the shape could be activated for
| edit or not. Has no effect when the older editable
| shapes mode is enabled via `config.editable` or
| `config.edits.shapePosition`.
| fillcolor
| Sets the color filling the shape's interior. Only
| applies to closed shapes.
| fillrule
| Determines which regions of complex paths constitute
| the interior. For more info please visit
| https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.shape.Label`
| instance or dict with compatible properties
| layer
| Specifies whether shapes are drawn below gridlines
| ("below"), between gridlines and traces ("between") or
| above traces ("above").
| legend
| Sets the reference to a legend to show this shape in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this shape. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.shape.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this shape. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this shape.
| line
| :class:`plotly.graph_objects.layout.shape.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the shape.
| path
| For `type` "path" - a valid SVG path with the pixel
| values replaced by data values in
| `xsizemode`/`ysizemode` being "scaled" and taken
| unmodified as pixels relative to `xanchor` and
| `yanchor` in case of "pixel" size mode. There are a few
| restrictions / quirks only absolute instructions, not
| relative. So the allowed segments are: M, L, H, V, Q,
| C, T, S, and Z arcs (A) are not allowed because radius
| rx and ry are relative. In the future we could consider
| supporting relative commands, but we would have to
| decide on how to handle date and log axes. Note that
| even as is, Q and C Bezier paths that are smooth on
| linear axes may not be smooth on log, and vice versa.
| no chained "polybezier" commands - specify the segment
| type for each one. On category axes, values are numbers
| scaled to the serial numbers of categories because
| using the categories themselves there would be no way
| to describe fractional positions On data axes: because
| space and T are both normal components of path strings,
| we can't use either to separate date from time parts.
| Therefore we'll use underscore for this purpose:
| 2015-02-21_13:45:56.789
| showlegend
| Determines whether or not this shape is shown in the
| legend.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the shape type to be drawn. If "line", a line
| is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect
| to the axes' sizing mode. If "circle", a circle is
| drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius
| (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with
| respect to the axes' sizing mode. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to
| the axes' sizing mode. If "path", draw a custom SVG
| path using `path`. with respect to the axes' sizing
| mode.
| visible
| Determines whether or not this shape is visible. If
| "legendonly", the shape is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Sets the shape's starting x position. See `type` and
| `xsizemode` for more info.
| x0shift
| Shifts `x0` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| x1
| Sets the shape's end x position. See `type` and
| `xsizemode` for more info.
| x1shift
| Shifts `x1` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| xanchor
| Only relevant in conjunction with `xsizemode` set to
| "pixel". Specifies the anchor point on the x axis to
| which `x0`, `x1` and x coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `xsizemode` not
| set to "pixel".
| xref
| Sets the shape's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xsizemode
| Sets the shapes's sizing mode along the x axis. If set
| to "scaled", `x0`, `x1` and x coordinates within `path`
| refer to data values on the x axis or a fraction of the
| plot area's width (`xref` set to "paper"). If set to
| "pixel", `xanchor` specifies the x position in terms of
| data or plot fraction but `x0`, `x1` and x coordinates
| within `path` are pixels relative to `xanchor`. This
| way, the shape can have a fixed width while maintaining
| a position relative to data or plot fraction.
| y0
| Sets the shape's starting y position. See `type` and
| `ysizemode` for more info.
| y0shift
| Shifts `y0` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| y1
| Sets the shape's end y position. See `type` and
| `ysizemode` for more info.
| y1shift
| Shifts `y1` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| yanchor
| Only relevant in conjunction with `ysizemode` set to
| "pixel". Specifies the anchor point on the y axis to
| which `y0`, `y1` and y coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `ysizemode` not
| set to "pixel".
| yref
| Sets the shape's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| ysizemode
| Sets the shapes's sizing mode along the y axis. If set
| to "scaled", `y0`, `y1` and y coordinates within `path`
| refer to data values on the y axis or a fraction of the
| plot area's height (`yref` set to "paper"). If set to
| "pixel", `yanchor` specifies the y position in terms of
| data or plot fraction but `y0`, `y1` and y coordinates
| within `path` are pixels relative to `yanchor`. This
| way, the shape can have a fixed height while
| maintaining a position relative to data or plot
| fraction.
| row
| Subplot row for shape. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for shape. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add shape to secondary y-axis
| exclude_empty_subplots
| If True, shape will not be added to subplots without
| traces.
|
| Returns
| -------
| Figure
|
| add_splom(self, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Splom trace
|
| Splom traces generate scatter plot matrix visualizations. Each
| splom `dimensions` items correspond to a generated axis. Values
| for each of those dimensions are set in `dimensions[i].values`.
| Splom traces support all `scattergl` marker style attributes.
| Specify `layout.grid` attributes and/or layout x-axis and
| y-axis attributes for more control over the axis positioning
| and style.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| diagonal
| :class:`plotly.graph_objects.splom.Diagonal` instance
| or dict with compatible properties
| dimensions
| A tuple of
| :class:`plotly.graph_objects.splom.Dimension` instances
| or dicts with compatible properties
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the
| default property values to use for elements of
| splom.dimensions
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.splom.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.splom.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.splom.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.splom.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showlowerhalf
| Determines whether or not subplots on the lower half
| from the diagonal are displayed.
| showupperhalf
| Determines whether or not subplots on the upper half
| from the diagonal are displayed.
| stream
| :class:`plotly.graph_objects.splom.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair to
| appear on hover. If a single string, the same string
| appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.splom.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxes
| Sets the list of x axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N xaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| yaxes
| Sets the list of y axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N yaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_streamtube(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Streamtube trace
|
| Use a streamtube trace to visualize flow in a vector field.
| Specify a vector field using 6 1D arrays of equal length, 3
| position arrays `x`, `y` and `z` and 3 vector component arrays
| `u`, `v`, and `w`. By default, the tubes' starting positions
| will be cut from the vector field's x-z plane at its minimum y
| value. To specify your own starting position, use attributes
| `starts.x`, `starts.y` and `starts.z`. The color is encoded by
| the norm of (u, v, w), and the local radius by the divergence
| of (u, v, w).
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.streamtube.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.streamtube.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `tubex`, `tubey`, `tubez`, `tubeu`,
| `tubev`, `tubew`, `norm` and `divergence`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.streamtube.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.streamtube.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.streamtube.Lightposition`
| instance or dict with compatible properties
| maxdisplayed
| The maximum number of displayed segments in a
| streamtube.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizeref
| The scaling factor for the streamtubes. The default is
| 1, which avoids two max divergence tubes from touching
| at adjacent starting positions.
| starts
| :class:`plotly.graph_objects.streamtube.Starts`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.streamtube.Stream`
| instance or dict with compatible properties
| text
| Sets a text element associated with this trace. If
| trace `hoverinfo` contains a "text" flag, this text
| element will be seen in all hover labels. Note that
| streamtube traces do not support array `text` values.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_sunburst(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Sunburst trace
|
| Visualize hierarchal data spanning outward radially from root
| to leaves. The sunburst sectors are determined by the entries
| in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sunburst.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.sunburst.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.sunburst.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sunburst.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.sunburst.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented at the center of a sunburst graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| root
| :class:`plotly.graph_objects.sunburst.Root` instance or
| dict with compatible properties
| rotation
| Rotates the whole diagram counterclockwise by some
| angle. By default the first slice starts at 3 o'clock.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.sunburst.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_surface(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Surface trace
|
| The data the describes the coordinates of the surface is set in
| `z`. Data in `z` should be a 2D list. Coordinates in `x` and
| `y` can either be 1D lists or 2D lists (e.g. to graph
| parametric surfaces). If not provided in `x` and `y`, the x and
| y coordinates are assumed to be linear starting at 0 with a
| unit step. The color scale corresponds to the `z` values by
| default. For custom color scales, use `surfacecolor` which
| should be a 2D list, where its bounds can be controlled using
| `cmin` and `cmax`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here z or surfacecolor)
| or the bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as z or surfacecolor.
| Has no effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmax` must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.surface.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| :class:`plotly.graph_objects.surface.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hidesurface
| Determines whether or not a surface is drawn. For
| example, set `hidesurface` to False `contours.x.show`
| to True and `contours.y.show` to True to draw a wire
| frame plot.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.surface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.surface.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.surface.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.surface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.surface.Stream` instance
| or dict with compatible properties
| surfacecolor
| Sets the surface color values, used for setting a color
| scale independent of `z`.
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
| text
| Sets the text elements associated with each z value. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Table trace
|
| Table view for detailed data viewing. The data are arranged in
| a grid of rows and columns. Most styling can be specified for
| columns, rows or individual cells. Table is using a column-
| major order, ie. the grid is represented as a vector of column
| vectors.
|
| Parameters
| ----------
| cells
| :class:`plotly.graph_objects.table.Cells` instance or
| dict with compatible properties
| columnorder
| Specifies the rendered order of the data columns; for
| example, a value `2` at position `0` means that column
| index `0` in the data will be rendered as the third
| column, as columns have an index base of zero.
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
| columnwidth
| The width of columns expressed as a ratio. Columns fill
| the available width in proportion of their specified
| column widths.
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.table.Domain` instance or
| dict with compatible properties
| header
| :class:`plotly.graph_objects.table.Header` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.table.Hoverlabel` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.table.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| stream
| :class:`plotly.graph_objects.table.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_trace(self, trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) -> 'Figure'
| 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 : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
| * The trace argument is a 2D cartesian trace
| (scatter, bar, etc.)
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
| Returns
| -------
| BaseFigure
| The Figure that add_trace was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS
| Figure(...)
|
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) # doctest: +ELLIPSIS
| Figure(...)
|
| add_traces(self, data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) -> 'Figure'
| Add traces to the figure
|
| Parameters
| ----------
| data : list[BaseTraceType or dict]
| A list of trace specifications to be added.
| Trace specifications may be either:
|
| - Instances of trace classes from the plotly.graph_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, list[int], or int (default None)
| List of subplot row indexes (starting from 1) for the traces to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to row number
|
| cols : None or list[int] (default None)
| List of subplot column indexes (starting from 1) for the traces
| to be added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to column number
|
|
| secondary_ys: None or list[boolean] (default None)
| List of secondary_y booleans for traces to be added. See the
| docstring for `add_trace` for more info.
|
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
|
| Returns
| -------
| BaseFigure
| The Figure that add_traces was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])]) # doctest: +ELLIPSIS
| Figure(...)
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
| ... go.Scatter(x=[1,2,3], y=[2,1,2])],
| ... rows=[1, 2], cols=[1, 1]) # doctest: +ELLIPSIS
| Figure(...)
|
| add_treemap(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Treemap trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The treemap sectors are
| determined by the entries in "labels" or "ids" and in
| "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.treemap.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.treemap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.treemap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.treemap.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.treemap.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.treemap.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.treemap.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.treemap.Tiling` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_violin(self, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Violin trace
|
| In vertical (horizontal) violin plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| violin per distinct x (y) value is drawn If no `x` (`y`) list
| is provided, a single violin is drawn. That violin position is
| then positioned with with `name` or with `x0` (`y0`) if
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| bandwidth
| Sets the bandwidth used to compute the kernel density
| estimate. By default, the bandwidth is determined by
| Silverman's rule of thumb.
| box
| :class:`plotly.graph_objects.violin.Box` instance or
| dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.violin.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual violins or
| sample points or the kernel density estimate or any
| combination of them?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the violins.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.violin.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.violin.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.violin.Marker` instance or
| dict with compatible properties
| meanline
| :class:`plotly.graph_objects.violin.Meanline` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For violin traces, the name
| will also be used for the position coordinate, if `x`
| and `x0` (`y` and `y0` if horizontal) are missing and
| the position axis is categorical. Note that the trace
| name is also used as a default value for attribute
| `scalegroup` (please see its description for details).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the violin(s). If "v" ("h"),
| the distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the violins. If 0, the sample points are places over
| the center of the violins. Positive (negative) values
| correspond to positions to the right (left) for
| vertical violins and above (below) for horizontal
| violins.
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the violins are shown with no sample
| points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set, otherwise defaults to "outliers".
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| scalegroup
| If there are multiple violins that should be sized
| according to to some metric (see `scalemode`), link
| them by providing a non-empty group id here shared by
| every trace in the same group. If a violin's `width` is
| undefined, `scalegroup` will default to the trace's
| name. In this case, violins with the same names will be
| linked together
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same
| (max) width "count" means the violins are scaled by the
| number of sample points making up each violin.
| selected
| :class:`plotly.graph_objects.violin.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| side
| Determines on which side of the position value the
| density function making up one half of a violin is
| plotted. Useful when comparing two violin traces under
| "overlay" mode, where one trace has `side` set to
| "positive" and the other to "negative".
| span
| Sets the span in data space for which the density
| function will be computed. Has an effect only when
| `spanmode` is set to "manual".
| spanmode
| Sets the method by which the span in data space where
| the density function will be computed. "soft" means the
| span goes from the sample's minimum value minus two
| bandwidths to the sample's maximum value plus two
| bandwidths. "hard" means the span goes from the
| sample's minimum to its maximum value. For custom span
| settings, use mode "manual" and fill in the `span`
| attribute.
| stream
| :class:`plotly.graph_objects.violin.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.violin.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the width of the violin in data coordinates. If 0
| (default value) the width is automatically selected
| based on the positions of other violin traces in the
| same subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_vline(self, x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a vertical line to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x: float or int
| A number representing the x coordinate of the vertical line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_volume(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Volume trace
|
| Draws volume trace between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.volume.Caps` instance or
| dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.volume.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.volume.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.volume.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.volume.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.volume.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.volume.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.volume.Slices` instance or
| dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.volume.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.volume.Stream` instance or
| dict with compatible properties
| surface
| :class:`plotly.graph_objects.volume.Surface` instance
| or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_vrect(self, x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a rectangle to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x0: float or int
| A number representing the x coordinate of one side of the rectangle.
| x1: float or int
| A number representing the x coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_waterfall(self, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Waterfall trace
|
| Draws waterfall trace which is useful graph to displays the
| contribution of various elements (either positive or negative)
| in a bar chart. The data visualized by the span of the bars is
| set in `y` if `orientation` is set to "v" (the default) and the
| labels are set in `x`. By setting `orientation` to "h", the
| roles are interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units).
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.waterfall.Connector`
| instance or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.waterfall.Decreasing`
| instance or dict with compatible properties
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.waterfall.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta` and `final`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.waterfall.Increasing`
| instance or dict with compatible properties
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.waterfall.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| measure
| An array containing types of values. By default the
| values are considered as 'relative'. However; it is
| possible to use 'total' to compute the sums. Also
| 'absolute' could be applied to reset the computed total
| or to declare an initial value where needed.
| measuresrc
| Sets the source reference on Chart Studio Cloud for
| `measure`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.waterfall.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple waterfalls, totals are
| computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta`, `final` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| totals
| :class:`plotly.graph_objects.waterfall.Totals` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| for_each_annotation(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all annotations that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single annotation object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotations that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_coloraxis(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all coloraxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single coloraxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_geo(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all geo objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single geo object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_layout_image(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all images that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single image object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| images that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_legend(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all legend objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single legend object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_map(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all map objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single map object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_mapbox(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all mapbox objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single mapbox object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_polar(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all polar objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single polar object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_scene(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all scene objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single scene object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_selection(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all selections that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single selection object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selections that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_shape(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all shapes that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single shape object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shapes that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_smith(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all smith objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single smith object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_ternary(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all ternary objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single ternary object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_trace(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'Figure'
| Apply a function to all traces that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single trace object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_xaxis(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all xaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single xaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'Figure'
| Apply a function to all yaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single yaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| select_annotations(self, selector=None, row=None, col=None, secondary_y=None)
| Select annotations from a particular subplot cell and/or annotations
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the annotations that satisfy
| all of the specified selection criteria
|
| select_coloraxes(self, selector=None, row=None, col=None)
| Select coloraxis subplot objects from a particular subplot cell
| and/or coloraxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the coloraxis
| objects that satisfy all of the specified selection criteria
|
| select_geos(self, selector=None, row=None, col=None)
| Select geo subplot objects from a particular subplot cell
| and/or geo subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the geo
| objects that satisfy all of the specified selection criteria
|
| select_layout_images(self, selector=None, row=None, col=None, secondary_y=None)
| Select images from a particular subplot cell and/or images
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the images that satisfy
| all of the specified selection criteria
|
| select_legends(self, selector=None, row=None, col=None)
| Select legend subplot objects from a particular subplot cell
| and/or legend subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the legend
| objects that satisfy all of the specified selection criteria
|
| select_mapboxes(self, selector=None, row=None, col=None)
| Select mapbox subplot objects from a particular subplot cell
| and/or mapbox subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the mapbox
| objects that satisfy all of the specified selection criteria
|
| select_maps(self, selector=None, row=None, col=None)
| Select map subplot objects from a particular subplot cell
| and/or map subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the map
| objects that satisfy all of the specified selection criteria
|
| select_polars(self, selector=None, row=None, col=None)
| Select polar subplot objects from a particular subplot cell
| and/or polar subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the polar
| objects that satisfy all of the specified selection criteria
|
| select_scenes(self, selector=None, row=None, col=None)
| Select scene subplot objects from a particular subplot cell
| and/or scene subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the scene
| objects that satisfy all of the specified selection criteria
|
| select_selections(self, selector=None, row=None, col=None, secondary_y=None)
| Select selections from a particular subplot cell and/or selections
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the selections that satisfy
| all of the specified selection criteria
|
| select_shapes(self, selector=None, row=None, col=None, secondary_y=None)
| Select shapes from a particular subplot cell and/or shapes
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the shapes that satisfy
| all of the specified selection criteria
|
| select_smiths(self, selector=None, row=None, col=None)
| Select smith subplot objects from a particular subplot cell
| and/or smith subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the smith
| objects that satisfy all of the specified selection criteria
|
| select_ternaries(self, selector=None, row=None, col=None)
| Select ternary subplot objects from a particular subplot cell
| and/or ternary subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the ternary
| objects that satisfy all of the specified selection criteria
|
| select_xaxes(self, selector=None, row=None, col=None)
| Select xaxis subplot objects from a particular subplot cell
| and/or xaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the xaxis
| objects that satisfy all of the specified selection criteria
|
| select_yaxes(self, selector=None, row=None, col=None, secondary_y=None)
| Select yaxis subplot objects from a particular subplot cell
| and/or yaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the yaxis
| objects that satisfy all of the specified selection criteria
|
| set_subplots(self, rows=None, cols=None, **make_subplots_args) -> 'Figure'
| Add subplots to this figure. If the figure already contains subplots,
| then this throws an error. Accepts any keyword arguments that
| plotly.subplots.make_subplots accepts.
|
| update(self, dict1=None, overwrite=False, **kwargs) -> 'Figure'
| Update the properties of the figure with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the figure
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Examples
| --------
| >>> import plotly.graph_objs as go
| >>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
| >>> fig.update(data=[{'y': [4, 5, 6]}]) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'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'}}}) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'data': [],
| 'layout': {'xaxis':
| {'color': 'pink',
| 'range': [0, 1]}}}
|
| Returns
| -------
| BaseFigure
| Updated figure
|
| update_annotations(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all annotations that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all annotations that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected annotation. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_coloraxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all coloraxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| coloraxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| coloraxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_geos(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all geo objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| geo objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| geo object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_layout(self, dict1=None, overwrite=False, **kwargs) -> 'Figure'
| Update the properties of the figure's layout with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| layout with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BaseFigure
| The Figure object that the update_layout method was called on
|
| update_layout_images(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all images that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all images that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected image. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_legends(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all legend objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| legend objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| legend object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_mapboxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all mapbox objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| mapbox objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| mapbox object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_maps(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all map objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| map objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| map object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_polars(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all polar objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| polar objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| polar object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_scenes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all scene objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| scene objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| scene object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_selections(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all selections that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all selections that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected selection. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_shapes(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all shapes that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all shapes that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected shape. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_smiths(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all smith objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| smith objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| smith object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_ternaries(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all ternary objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| ternary objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| ternary object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_traces(self, patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) -> 'Figure'
| Perform a property update operation on all traces that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all traces that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| **kwargs
| Additional property updates to apply to each selected trace. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_xaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all xaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| xaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| xaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_yaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all yaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| yaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected
| yaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFigure:
|
| __contains__(self, prop)
|
| __eq__(self, other)
| Return self==value.
|
| __getitem__(self, prop)
|
| __iter__(self)
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __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)
|
| 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(self, duration=500, easing='cubic-in-out')
| 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_animate(duration=2000, easing='elastic-in-out'):
| ... fig.data[0].marker.color = 'green'
| ... fig.data[0].marker.size = 20
|
| batch_update(self)
| 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.
|
| full_figure_for_development(self, warn=True, as_dict=False)
| Compute default values for all attributes not specified in the input figure and
| returns the output as a "full" figure. This function calls Plotly.js via Kaleido
| to populate unspecified attributes. This function is intended for interactive use
| during development to learn more about how Plotly.js computes default values and is
| not generally necessary or recommended for production use.
|
| Parameters
| ----------
| fig:
| Figure object or dict representing a figure
|
| warn: bool
| If False, suppress warnings about not using this in production.
|
| as_dict: bool
| If True, output is a dict with some keys that go.Figure can't parse.
| If False, output is a go.Figure with unparseable keys skipped.
|
| Returns
| -------
| plotly.graph_objects.Figure or dict
| The full figure
|
| get_subplot(self, row, col, secondary_y=False)
| Return an object representing the subplot at the specified row
| and column. May only be used on Figures created using
| plotly.tools.make_subplots
|
| Parameters
| ----------
| row: int
| 1-based index of subplot row
| col: int
| 1-based index of subplot column
| secondary_y: bool
| If True, select the subplot that consists of the x-axis and the
| secondary y-axis at the specified row/col. Only valid if the
| subplot at row/col is an 2D cartesian subplot that was created
| with a secondary y-axis. See the docstring for the specs argument
| to make_subplots for more info on creating a subplot with a
| secondary y-axis.
| Returns
| -------
| subplot
| * None: if subplot is empty
| * plotly.graph_objs.layout.Scene: if subplot type is 'scene'
| * plotly.graph_objs.layout.Polar: if subplot type is 'polar'
| * plotly.graph_objs.layout.Ternary: if subplot type is 'ternary'
| * plotly.graph_objs.layout.Mapbox: if subplot type is 'ternary'
| * SubplotDomain namedtuple with `x` and `y` fields:
| if subplot type is 'domain'.
| - x: length 2 list of the subplot start and stop width
| - y: length 2 list of the subplot start and stop height
| * SubplotXY namedtuple with `xaxis` and `yaxis` fields:
| if subplot type is 'xy'.
| - xaxis: plotly.graph_objs.layout.XAxis instance for subplot
| - yaxis: plotly.graph_objs.layout.YAxis instance for subplot
|
| 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]
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[2, 4, 6]))
| >>> 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
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in figure
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| 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.
|
| select_traces(self, selector=None, row=None, col=None, secondary_y=None)
| Select traces from a particular subplot cell and/or traces
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the traces that satisfy
| all of the specified selection criteria
|
| show(self, *args, **kwargs)
| Show a figure using either the default renderer(s) or the renderer(s)
| specified by the renderer argument
|
| Parameters
| ----------
| renderer: str or None (default None)
| A string containing the names of one or more registered renderers
| (separated by '+' characters) or None. If None, then the default
| renderers specified in plotly.io.renderers.default are used.
|
| validate: bool (default True)
| True if the figure should be validated before being shown,
| False otherwise.
|
| width: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| height: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| config: dict
| A dict of parameters to configure the figure. The defaults are set
| in plotly.js.
|
| Returns
| -------
| None
|
| 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_html(self, *args, **kwargs)
| Convert a figure to an HTML string representation.
|
| Parameters
| ----------
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| str
| Representation of figure as an HTML div string
|
| to_image(self, *args, **kwargs)
| Convert a figure to a static image bytes string
|
| Parameters
| ----------
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified, will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
|
| Returns
| -------
| bytes
| The image data
|
| to_json(self, *args, **kwargs)
| Convert a figure to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of figure as a JSON string
|
| to_ordered_dict(self, skip_uid=True)
|
| to_plotly_json(self)
| Convert figure to a JSON representation as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| write_html(self, *args, **kwargs)
| Write a figure to an HTML file representation
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file. If `file` is a string to a local file
| path and `full_html` is True, then the plotly.min.js bundle is copied
| into the directory of the resulting HTML file. If a file named
| plotly.min.js already exists in the output directory then this file
| is left unmodified and no copy is performed. HTML files generated
| with this option can be used offline, but they require a copy of
| the plotly.min.js bundle in the same directory. This option is
| useful when many figures will be saved as HTML files in the same
| directory because the plotly.js source code will be included only
| once per output directory, rather than once per output file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
|
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| auto_open: bool (default True)
| If True, open the saved file in a web browser after saving.
| This argument only applies if `full_html` is True.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| None
|
| write_image(self, *args, **kwargs)
| Convert a figure to a static image and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
|
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified and `file` is a string then this will default to the
| file extension. If not specified and `file` is not a string then this
| will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
| Returns
| -------
| None
|
| write_json(self, *args, **kwargs)
| Convert a figure to JSON and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. an open file descriptor)
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| None
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BaseFigure:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| data
| The `data` property is a tuple of the figure's trace objects
|
| Returns
| -------
| tuple[BaseTraceType]
|
| frames
| The `frames` property is a tuple of the figure's frame objects
|
| Returns
| -------
| tuple[plotly.graph_objs.Frame]
|
| layout
| The `layout` property of the figure
|
| Returns
| -------
| plotly.graph_objs.Layout
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BaseFigure:
|
| __hash__ = None
class FigureWidget(plotly.basewidget.BaseFigureWidget)
| FigureWidget(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
|
| 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
| builtins.object
|
| Methods defined here:
|
| __init__(self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
| Create a new :class: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 single trace instance
| (e.g. Scatter(...), Bar(...), etc.)
| - A list or tuple of dicts of string/value properties where:
| - The 'type' property specifies the trace type
| One of: ['bar', 'barpolar', 'box', 'candlestick',
| 'carpet', 'choropleth', 'choroplethmap',
| 'choroplethmapbox', 'cone', 'contour',
| 'contourcarpet', 'densitymap',
| 'densitymapbox', 'funnel', 'funnelarea',
| 'heatmap', 'heatmapgl', 'histogram',
| 'histogram2d', 'histogram2dcontour', 'icicle',
| 'image', 'indicator', 'isosurface', 'mesh3d',
| 'ohlc', 'parcats', 'parcoords', 'pie',
| 'pointcloud', 'sankey', 'scatter',
| 'scatter3d', 'scattercarpet', 'scattergeo',
| 'scattergl', 'scattermap', 'scattermapbox',
| 'scatterpolar', 'scatterpolargl',
| 'scattersmith', 'scatterternary', 'splom',
| 'streamtube', 'sunburst', 'surface', 'table',
| 'treemap', 'violin', 'volume', 'waterfall']
|
| - 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 :class:`plotly.graph_objs.Layout`
| - A dict of string/value properties that will be passed
| to the Layout constructor
|
| Supported dict properties:
|
| activeselection
| :class:`plotly.graph_objects.layout.Activeselec
| tion` instance or dict with compatible
| properties
| activeshape
| :class:`plotly.graph_objects.layout.Activeshape
| ` instance or dict with compatible properties
| annotations
| A tuple of
| :class:`plotly.graph_objects.layout.Annotation`
| instances or dicts with compatible properties
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults),
| sets the default property values to use for
| elements of layout.annotations
| 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.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. This is the default value;
| however it could be overridden for individual
| axes.
| barcornerradius
| Sets the rounding of bar corners. May be an
| integer number of pixels, or a percentage of
| bar width (as a string ending in %).
| 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 reduce "opacity" to
| see multiple bars.
| barnorm
| Sets the normalization for bar traces on the
| graph. With "fraction", the value of each bar
| is divided by the sum of all values at that
| location coordinate. "percent" is the same but
| multiplied by 100 to show percentages.
| boxgap
| Sets the gap (in plot fraction) between boxes
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| boxmode
| Determines how boxes at the same location
| coordinate are displayed on the graph. If
| "group", the boxes are plotted next to one
| another centered around the shared location. If
| "overlay", the boxes are plotted over one
| another, you might need to set "opacity" to see
| them multiple boxes. Has no effect on traces
| that have "width" set.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout
| the plot.
| clickmode
| Determines the mode of single click
| interactions. "event" is the default value and
| emits the `plotly_click` event. In addition
| this mode emits the `plotly_selected` event in
| drag modes "lasso" and "select", but with no
| event data attached (kept for compatibility
| reasons). The "select" flag enables selecting
| single data points via click. This mode also
| supports persistent selections, meaning that
| pressing Shift while clicking, adds to /
| subtracts from an existing selection. "select"
| with `hovermode`: "x" can be confusing,
| consider explicitly setting `hovermode`:
| "closest" when using this feature. Selection
| events are sent accordingly as long as "event"
| flag is set as well. When the "event" flag is
| missing, `plotly_click` and `plotly_selected`
| events are not fired.
| coloraxis
| :class:`plotly.graph_objects.layout.Coloraxis`
| instance or dict with compatible properties
| colorscale
| :class:`plotly.graph_objects.layout.Colorscale`
| instance or dict with compatible properties
| colorway
| Sets the default trace colors.
| computed
| Placeholder for exporting automargin-impacting
| values namely `margin.t`, `margin.b`,
| `margin.l` and `margin.r` in "full-json" mode.
| 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.
| 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.
| editrevision
| Controls persistence of user-driven changes in
| `editable: true` configuration, other than
| trace names and axis titles. Defaults to
| `layout.uirevision`.
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether
| given by `funnelareacolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendiciclecolors
| If `true`, the icicle slice colors (whether
| given by `iciclecolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendpiecolors
| If `true`, the pie slice colors (whether given
| by `piecolorway` or inherited from `colorway`)
| will be extended to three times its original
| length by first repeating every color 20%
| lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether
| given by `sunburstcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendtreemapcolors
| If `true`, the treemap slice colors (whether
| given by `treemapcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| font
| Sets the global font. Note that fonts used in
| traces and other layout components inherit from
| the global font.
| funnelareacolorway
| Sets the default funnelarea slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendfunnelareacolors`.
| funnelgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| funnelmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "stack", the bars are stacked on top of one
| another With "group", the bars are plotted next
| to one another centered around the shared
| location. With "overlay", the bars are plotted
| over one another, you might need to reduce
| "opacity" to see multiple bars.
| geo
| :class:`plotly.graph_objects.layout.Geo`
| instance or dict with compatible properties
| grid
| :class:`plotly.graph_objects.layout.Grid`
| instance or dict with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart
| analog of visible:'legendonly' but it can
| contain many labels, and can simultaneously
| hide slices from several pies/funnelarea charts
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud
| 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 Chart Studio Cloud (at
| https://chart-studio.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
| :class:`plotly.graph_objects.layout.Hoverlabel`
| instance or dict with compatible properties
| hovermode
| Determines the mode of hover interactions. If
| "closest", a single hoverlabel will appear for
| the "closest" point within the `hoverdistance`.
| If "x" (or "y"), multiple hoverlabels will
| appear for multiple points at the "closest" x-
| (or y-) coordinate within the `hoverdistance`,
| with the caveat that no more than one
| hoverlabel will appear per trace. If *x
| unified* (or *y unified*), a single hoverlabel
| will appear multiple points at the closest x-
| (or y-) coordinate within the `hoverdistance`
| with the caveat that no more than one
| hoverlabel will appear per trace. In this mode,
| spikelines are enabled by default perpendicular
| to the specified axis. If false, hover
| interactions are disabled.
| hoversubplots
| Determines expansion of hover effects to other
| subplots If "single" just the axis pair of the
| primary point is included without overlaying
| subplots. If "overlaying" all subplots using
| the main axis and occupying the same space are
| included. If "axis", also include stacked
| subplots using the same axis when `hovermode`
| is set to "x", *x unified*, "y" or *y unified*.
| iciclecolorway
| Sets the default icicle slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendiciclecolors`.
| images
| A tuple of
| :class:`plotly.graph_objects.layout.Image`
| instances or dicts with compatible properties
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the
| default property values to use for elements of
| layout.images
| legend
| :class:`plotly.graph_objects.layout.Legend`
| instance or dict with compatible properties
| map
| :class:`plotly.graph_objects.layout.Map`
| instance or dict with compatible properties
| mapbox
| :class:`plotly.graph_objects.layout.Mapbox`
| instance or dict with compatible properties
| margin
| :class:`plotly.graph_objects.layout.Margin`
| instance or dict with compatible properties
| meta
| Assigns extra meta information that can be used
| in various `text` attributes. Attributes such
| as the graph, axis and colorbar `title.text`,
| annotation `text` `trace.name` in legend items,
| `rangeselector`, `updatemenus` and `sliders`
| `label` text all support `meta`. One can access
| `meta` fields using template strings:
| `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an
| object for example `{key: value}` which can be
| accessed %{meta[key]}.
| metasrc
| Sets the source reference on Chart Studio Cloud
| for `meta`.
| minreducedheight
| Minimum height of the plot with
| margin.automargin applied (in px)
| minreducedwidth
| Minimum width of the plot with
| margin.automargin applied (in px)
| modebar
| :class:`plotly.graph_objects.layout.Modebar`
| instance or dict with compatible properties
| newselection
| :class:`plotly.graph_objects.layout.Newselectio
| n` instance or dict with compatible properties
| newshape
| :class:`plotly.graph_objects.layout.Newshape`
| instance or dict with compatible properties
| paper_bgcolor
| Sets the background color of the paper where
| the graph is drawn.
| piecolorway
| Sets the default pie slice colors. Defaults to
| the main `colorway` used for trace colors. If
| you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendpiecolors`.
| plot_bgcolor
| Sets the background color of the plotting area
| in-between x and y axes.
| polar
| :class:`plotly.graph_objects.layout.Polar`
| instance or dict with compatible properties
| scattergap
| Sets the gap (in plot fraction) between scatter
| points of adjacent location coordinates.
| Defaults to `bargap`.
| scattermode
| Determines how scatter points at the same
| location coordinate are displayed on the graph.
| With "group", the scatter points are plotted
| next to one another centered around the shared
| location. With "overlay", the scatter points
| are plotted over one another, you might need to
| reduce "opacity" to see multiple scatter
| points.
| scene
| :class:`plotly.graph_objects.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.
| selectionrevision
| Controls persistence of user-driven changes in
| selected points from all traces.
| selections
| A tuple of
| :class:`plotly.graph_objects.layout.Selection`
| instances or dicts with compatible properties
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets
| the default property values to use for elements
| of layout.selections
| 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
| A tuple of
| :class:`plotly.graph_objects.layout.Shape`
| instances or dicts with compatible properties
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the
| default property values to use for elements of
| layout.shapes
| showlegend
| Determines whether or not a legend is drawn.
| Default is `true` if there is a trace to show
| and any of these: a) Two or more traces would
| by default be shown in the legend. b) One pie
| trace is shown in the legend. c) One trace is
| explicitly given with `showlegend: true`.
| sliders
| A tuple of
| :class:`plotly.graph_objects.layout.Slider`
| instances or dicts with compatible properties
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets
| the default property values to use for elements
| of layout.sliders
| smith
| :class:`plotly.graph_objects.layout.Smith`
| 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.
| sunburstcolorway
| Sets the default sunburst slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendsunburstcolors`.
| template
| Default attributes to be applied to the plot.
| This should be a dict with format: `{'layout':
| layoutTemplate, 'data': {trace_type:
| [traceTemplate, ...], ...}}` where
| `layoutTemplate` is a dict matching the
| structure of `figure.layout` and
| `traceTemplate` is a dict matching the
| structure of the trace with type `trace_type`
| (e.g. 'scatter'). Alternatively, this may be
| specified as an instance of
| plotly.graph_objs.layout.Template. Trace
| templates are applied cyclically to traces of
| each type. Container arrays (eg `annotations`)
| have special handling: An object ending in
| `defaults` (eg `annotationdefaults`) is applied
| to each array item. But if an item has a
| `templateitemname` key we look in the template
| array for an item with matching `name` and
| apply that instead. If no matching `name` is
| found we mark the item invisible. Any named
| template item not referenced is appended to the
| end of the array, so this can be used to add a
| watermark annotation or a logo image, for
| example. To omit one of these items on the
| plot, make an item with matching
| `templateitemname` and `visible: false`.
| ternary
| :class:`plotly.graph_objects.layout.Ternary`
| instance or dict with compatible properties
| title
| :class:`plotly.graph_objects.layout.Title`
| instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.title.font
| instead. Sets the title font. Note that the
| title's font used to be customized by the now
| deprecated `titlefont` attribute.
| transition
| Sets transition options used during
| Plotly.react updates.
| treemapcolorway
| Sets the default treemap slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendtreemapcolors`.
| uirevision
| Used to allow user interactions with the plot
| to persist after `Plotly.react` calls that are
| unaware of these interactions. If `uirevision`
| is omitted, or if it is given and it changed
| from the previous `Plotly.react` call, the
| exact new figure is used. If `uirevision` is
| truthy and did NOT change, any attribute that
| has been affected by user interactions and did
| not receive a different value in the new figure
| will keep the interaction value.
| `layout.uirevision` attribute serves as the
| default for `uirevision` attributes in various
| sub-containers. For finer control you can set
| these sub-attributes directly. For example, if
| your app separately controls the data on the x
| and y axes you might set
| `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y
| data is changed, you can update
| `yaxis.uirevision=*quantity*` and the y axis
| range will reset but the x axis range will
| retain any user-driven zoom.
| uniformtext
| :class:`plotly.graph_objects.layout.Uniformtext
| ` instance or dict with compatible properties
| updatemenus
| A tuple of
| :class:`plotly.graph_objects.layout.Updatemenu`
| instances or dicts with compatible properties
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults),
| sets the default property values to use for
| elements of layout.updatemenus
| violingap
| Sets the gap (in plot fraction) between violins
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| violingroupgap
| Sets the gap (in plot fraction) between violins
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| violinmode
| Determines how violins at the same location
| coordinate are displayed on the graph. If
| "group", the violins are plotted next to one
| another centered around the shared location. If
| "overlay", the violins are plotted over one
| another, you might need to set "opacity" to see
| them multiple violins. Has no effect on traces
| that have "width" set.
| waterfallgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| waterfallmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "group", the bars are plotted next to one
| another centered around the shared location.
| With "overlay", the bars are plotted over one
| another, you might need to reduce "opacity" to
| see multiple bars.
| width
| Sets the plot's width (in px).
| xaxis
| :class:`plotly.graph_objects.layout.XAxis`
| instance or dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.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
|
| skip_invalid: bool
| If True, invalid properties in the figure specification will be
| skipped silently. If False (default) invalid properties in the
| figure specification will result in a ValueError
|
| Raises
| ------
| ValueError
| if a property in the specification of data, layout, or frames
| is invalid AND skip_invalid is False
|
| add_annotation(self, arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new annotation to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Annotation or dict with compatible
| properties
| align
| Sets the horizontal alignment of the `text` within the
| box. Has an effect only if `text` spans two or more
| lines (i.e. `text` contains one or more <br> HTML tags)
| or if an explicit width is set to override the text
| width.
| arrowcolor
| Sets the color of the annotation arrow.
| arrowhead
| Sets the end annotation arrow head style.
| arrowside
| Sets the annotation arrow head position.
| arrowsize
| Sets the size of the end annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| arrowwidth
| Sets the width (in px) of annotation arrow line.
| ax
| Sets the x component of the arrow tail about the arrow
| head. If `axref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from right
| to left (left to right). If `axref` is not `pixel` and
| is exactly the same as `xref`, this is an absolute
| value on that axis, like `x`, specified in the same
| coordinates as `xref`.
| axref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a x axis id
| (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis. In order for absolute
| positioning of the arrow to work, "axref" must be
| exactly the same as "xref", otherwise "axref" will
| revert to "pixel" (explained next). For relative
| positioning, "axref" can be set to "pixel", in which
| case the "ax" value is specified in pixels relative to
| "x". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| ay
| Sets the y component of the arrow tail about the arrow
| head. If `ayref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from bottom
| to top (top to bottom). If `ayref` is not `pixel` and
| is exactly the same as `yref`, this is an absolute
| value on that axis, like `y`, specified in the same
| coordinates as `yref`.
| ayref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a y axis id
| (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis. In order for absolute
| positioning of the arrow to work, "ayref" must be
| exactly the same as "yref", otherwise "ayref" will
| revert to "pixel" (explained next). For relative
| positioning, "ayref" can be set to "pixel", in which
| case the "ay" value is specified in pixels relative to
| "y". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| bgcolor
| Sets the background color of the annotation.
| bordercolor
| Sets the color of the border enclosing the annotation
| `text`.
| borderpad
| Sets the padding (in px) between the `text` and the
| enclosing border.
| borderwidth
| Sets the width (in px) of the border enclosing the
| annotation `text`.
| captureevents
| Determines whether the annotation text box captures
| mouse move and click events, or allows those events to
| pass through to data points in the plot that may be
| behind the annotation. By default `captureevents` is
| False unless `hovertext` is provided. If you use the
| event `plotly_clickannotation` without `hovertext` you
| must explicitly enable `captureevents`.
| clicktoshow
| Makes this annotation respond to clicks on the plot. If
| you click a data point that exactly matches the `x` and
| `y` values of this annotation, and it is hidden
| (visible: false), it will appear. In "onoff" mode, you
| must click the same point again to make it disappear,
| so if you click multiple points, you can show multiple
| annotations. In "onout" mode, a click anywhere else in
| the plot (on another data point or not) will hide this
| annotation. If you need to show/hide this annotation in
| response to different `x` or `y` values, you can set
| `xclick` and/or `yclick`. This is useful for example to
| label the side of a bar. To label markers though,
| `standoff` is preferred over `xclick` and `yclick`.
| font
| Sets the annotation text font.
| height
| Sets an explicit height for the text box. null
| (default) lets the text set the box height. Taller text
| will be clipped.
| hoverlabel
| :class:`plotly.graph_objects.layout.annotation.Hoverlab
| el` instance or dict with compatible properties
| hovertext
| Sets text to appear when hovering over this annotation.
| If omitted or blank, no hover label will appear.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the annotation (text + arrow).
| showarrow
| Determines whether or not the annotation is drawn with
| an arrow. If True, `text` is placed near the arrow's
| tail. If False, `text` lines up with the `x` and `y`
| provided.
| standoff
| Sets a distance, in pixels, to move the end arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| startarrowhead
| Sets the start annotation arrow head style.
| startarrowsize
| Sets the size of the start annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| startstandoff
| Sets a distance, in pixels, to move the start arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| text
| Sets the text associated with this annotation. Plotly
| uses a subset of HTML tags to do things like newline
| (<br>), bold (<b></b>), italics (<i></i>), hyperlinks
| (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>
| <span> are also supported.
| textangle
| Sets the angle at which the `text` is drawn with
| respect to the horizontal.
| valign
| Sets the vertical alignment of the `text` within the
| box. Has an effect only if an explicit height is set to
| override the text height.
| visible
| Determines whether or not this annotation is visible.
| width
| Sets an explicit width for the text box. null (default)
| lets the text set the box width. Wider text will be
| clipped. There is no automatic wrapping; use <br> to
| start a new line.
| x
| Sets the annotation's x position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| xanchor
| Sets the text box's horizontal position anchor This
| anchor binds the `x` position to the "left", "center"
| or "right" of the annotation. For example, if `x` is
| set to 1, `xref` to "paper" and `xanchor` to "right"
| then the right-most portion of the annotation lines up
| with the right-most edge of the plotting area. If
| "auto", the anchor is equivalent to "center" for data-
| referenced annotations or if there is an arrow, whereas
| for paper-referenced with no arrow, the anchor picked
| corresponds to the closest side.
| xclick
| Toggle this annotation when clicking a data point whose
| `x` value is `xclick` rather than the annotation's `x`
| value.
| xref
| Sets the annotation's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xshift
| Shifts the position of the whole annotation and arrow
| to the right (positive) or left (negative) by this many
| pixels.
| y
| Sets the annotation's y position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| yanchor
| Sets the text box's vertical position anchor This
| anchor binds the `y` position to the "top", "middle" or
| "bottom" of the annotation. For example, if `y` is set
| to 1, `yref` to "paper" and `yanchor` to "top" then the
| top-most portion of the annotation lines up with the
| top-most edge of the plotting area. If "auto", the
| anchor is equivalent to "middle" for data-referenced
| annotations or if there is an arrow, whereas for paper-
| referenced with no arrow, the anchor picked corresponds
| to the closest side.
| yclick
| Toggle this annotation when clicking a data point whose
| `y` value is `yclick` rather than the annotation's `y`
| value.
| yref
| Sets the annotation's y coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| yshift
| Shifts the position of the whole annotation and arrow
| up (positive) or down (negative) by this many pixels.
| row
| Subplot row for annotation. If 'all', addresses all
| rows in the specified column(s).
| col
| Subplot column for annotation. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add annotation to secondary y-axis
| exclude_empty_subplots
| If True, annotation will not be added to subplots
| without traces.
|
| Returns
| -------
| FigureWidget
|
| add_bar(self, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Bar trace
|
| The data visualized by the span of the bars is set in `y` if
| `orientation` is set to "v" (the default) and the labels are
| set in `x`. By setting `orientation` to "h", the roles are
| interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units). In "stack" or "relative" barmode, traces that
| set "base" will be excluded and drawn in "overlay" mode
| instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.bar.ErrorX` instance or
| dict with compatible properties
| error_y
| :class:`plotly.graph_objects.bar.ErrorY` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.bar.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`. Anything contained in
| tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.bar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.bar.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.bar.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.bar.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.bar.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_barpolar(self, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Barpolar trace
|
| The data visualized by the radial span of the bars is set in
| `r`
|
| Parameters
| ----------
| base
| Sets where the bar base is drawn (in radial axis
| units). In "stack" barmode, traces that set "base" will
| be excluded and drawn in "overlay" mode instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.barpolar.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.barpolar.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.barpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.barpolar.Stream` instance
| or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.barpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar angular width (in "thetaunit" units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_box(self, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Box trace
|
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2, i.e. the median) is marked by a line
| inside the box. The fences grow outward from the boxes' edges,
| by default they span +/- 1.5 times the interquartile range
| (IQR: Q3-Q1), The sample mean and standard deviation as well as
| notches and the sample, outlier and suspected outliers points
| can be optionally added to the box plot. The values and
| positions corresponding to each boxes can be input using two
| signatures. The first signature expects users to supply the
| sample values in the `y` data array for vertical boxes (`x` for
| horizontal boxes). By supplying an `x` (`y`) array, one box per
| distinct `x` (`y`) value is drawn If no `x` (`y`) list is
| provided, a single box is drawn. In this case, the box is
| positioned with the trace `name` or with `x0` (`y0`) if
| provided. The second signature expects users to supply the
| boxes corresponding Q1, median and Q3 statistics in the `q1`,
| `median` and `q3` data arrays respectively. Other box features
| relying on statistics namely `lowerfence`, `upperfence`,
| `notchspan` can be set directly by the users. To have plotly
| compute them or to show sample points besides the boxes, users
| can set the `y` data array for vertical boxes (`x` for
| horizontal boxes) to a 2D array with the outer length
| corresponding to the number of boxes in the traces and the
| inner length corresponding the sample size.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| boxmean
| If True, the mean of the box(es)' underlying
| distribution is drawn as a dashed line inside the
| box(es). If "sd" the standard deviation is also drawn.
| Defaults to True when `mean` is set. Defaults to "sd"
| when `sd` is set Otherwise defaults to False.
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the box(es) are shown with no sample
| points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set. Defaults to "all" under the q1/median/q3
| signature. Otherwise defaults to "outliers".
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step for multi-box traces set
| using q1/median/q3.
| dy
| Sets the y coordinate step for multi-box traces set
| using q1/median/q3.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.box.Hoverlabel` instance
| or dict with compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the box(es).
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.box.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.box.Line` instance or dict
| with compatible properties
| lowerfence
| Sets the lower fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `lowerfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the lower as the last sample
| point below 1.5 times the IQR.
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
| marker
| :class:`plotly.graph_objects.box.Marker` instance or
| dict with compatible properties
| mean
| Sets the mean values. There should be as many items as
| the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `mean` is not
| provided but a sample (in `y` or `x`) is set, we
| compute the mean for each box using the sample values.
| meansrc
| Sets the source reference on Chart Studio Cloud for
| `mean`.
| median
| Sets the median values. There should be as many items
| as the number of boxes desired.
| mediansrc
| Sets the source reference on Chart Studio Cloud for
| `median`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For box traces, the name will
| also be used for the position coordinate, if `x` and
| `x0` (`y` and `y0` if horizontal) are missing and the
| position axis is categorical
| notched
| Determines whether or not notches are drawn. Notches
| displays a confidence interval around the median. We
| compute the confidence interval as median +/- 1.57 *
| IQR / sqrt(N), where IQR is the interquartile range and
| N is the sample size. If two boxes' notches do not
| overlap there is 95% confidence their medians differ.
| See https://sites.google.com/site/davidsstatistics/home
| /notched-box-plots for more info. Defaults to False
| unless `notchwidth` or `notchspan` is set.
| notchspan
| Sets the notch span from the boxes' `median` values.
| There should be as many items as the number of boxes
| desired. This attribute has effect only under the
| q1/median/q3 signature. If `notchspan` is not provided
| but a sample (in `y` or `x`) is set, we compute it as
| 1.57 * IQR / sqrt(N), where N is the sample size.
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
| notchwidth
| Sets the width of the notches relative to the box'
| width. For example, with 0, the notches are as wide as
| the box(es).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the box(es). If 0, the sample points are places over
| the center of the box(es). Positive (negative) values
| correspond to positions to the right (left) for
| vertical boxes and above (below) for horizontal boxes
| q1
| Sets the Quartile 1 values. There should be as many
| items as the number of boxes desired.
| q1src
| Sets the source reference on Chart Studio Cloud for
| `q1`.
| q3
| Sets the Quartile 3 values. There should be as many
| items as the number of boxes desired.
| q3src
| Sets the source reference on Chart Studio Cloud for
| `q3`.
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| sd
| Sets the standard deviation values. There should be as
| many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3
| signature. If `sd` is not provided but a sample (in `y`
| or `x`) is set, we compute the standard deviation for
| each box using the sample values.
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to
| be drawn across any stddev range For example 1-stddev,
| 3-stddev, 5-stddev
| sdsrc
| Sets the source reference on Chart Studio Cloud for
| `sd`.
| selected
| :class:`plotly.graph_objects.box.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showwhiskers
| Determines whether or not whiskers are visible.
| Defaults to true for `sizemode` "quartiles", false for
| "sd".
| sizemode
| Sets the upper and lower bound for the boxes quartiles
| means box is drawn between Q1 and Q3 SD means the box
| is drawn between Mean +- Standard Deviation Argument
| sdmultiple (default 1) to scale the box size So it
| could be drawn 1-stddev, 3-stddev etc
| stream
| :class:`plotly.graph_objects.box.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.box.Unselected` instance
| or dict with compatible properties
| upperfence
| Sets the upper fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `upperfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the upper as the last sample
| point above 1.5 times the IQR.
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| width
| Sets the width of the box in data coordinate If 0
| (default value) the width is automatically selected
| based on the positions of other box traces in the same
| subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_candlestick(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Candlestick trace
|
| The candlestick is a style of financial chart describing open,
| high, low and close for a given `x` coordinate (most likely
| time). The boxes represent the spread between the `open` and
| `close` values and the lines represent the spread between the
| `low` and `high` values Sample points where the close value is
| higher (lower) then the open value are called increasing
| (decreasing). By default, increasing candles are drawn in green
| whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.candlestick.Decreasing`
| instance or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.candlestick.Hoverlabel`
| instance or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.candlestick.Increasing`
| instance or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.candlestick.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.candlestick.Line` instance
| or dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.candlestick.Stream`
| instance or dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| 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, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Carpet trace
|
| The data describing carpet axis layout is set in `y` and
| (optionally) also `x`. If only `y` is present, `x` the plot is
| interpreted as a cheater plot and is filled in using the `y`
| values. `x` and `y` may either be 2D arrays matching with each
| dimension matching that of `a` and `b`, or they may be 1D
| arrays with total length equal to that of `a` and `b`.
|
| Parameters
| ----------
| a
| An array containing values of the first parameter value
| a0
| Alternate to `a`. Builds a linear space of a
| coordinates. Use with `da` where `a0` is the starting
| coordinate and `da` the step.
| aaxis
| :class:`plotly.graph_objects.carpet.Aaxis` instance or
| dict with compatible properties
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| A two dimensional array of y coordinates at each carpet
| point.
| b0
| Alternate to `b`. Builds a linear space of a
| coordinates. Use with `db` where `b0` is the starting
| coordinate and `db` the step.
| baxis
| :class:`plotly.graph_objects.carpet.Baxis` instance or
| dict with compatible properties
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| cheaterslope
| The shift applied to each successive row of data in
| creating a cheater plot. Only used if `x` is been
| omitted.
| color
| Sets default for all colors associated with this axis
| all at once: line, font, tick, and grid colors. Grid
| color is lightened by blending this with the plot
| background Individual pieces can override this.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the a coordinate step. See `a0` for more info.
| db
| Sets the b coordinate step. See `b0` for more info.
| font
| The default font used for axis & tick labels on this
| carpet
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.carpet.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| stream
| :class:`plotly.graph_objects.carpet.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| A two dimensional array of x coordinates at each carpet
| point. If omitted, the plot is a cheater plot and the
| xaxis is hidden by default.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| A two dimensional array of y coordinates at each carpet
| point.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_choropleth(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Choropleth trace
|
| The data that describes the choropleth value-to-color mapping
| is set in `z`. The geographic locations corresponding to each
| value in `z` are set in `locations`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choropleth.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choropleth.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choropleth.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choropleth.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choropleth.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choropleth.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choropleth.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_choroplethmap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Choroplethmap trace
|
| GeoJSON features to be filled are set in `geojson` The data
| that describes the choropleth value-to-color mapping is set in
| `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmap traces are placed above the water layers.
| If set to '', the layer will be inserted above every
| existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmap.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_choroplethmapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Choroplethmapbox trace
|
| "choroplethmapbox" trace is deprecated! Please consider
| switching to the "choroplethmap" trace type and `map` subplots.
| Learn more at: https://plotly.com/javascript/maplibre-
| migration/ GeoJSON features to be filled are set in `geojson`
| The data that describes the choropleth value-to-color mapping
| is set in `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmapbox traces are placed above the water
| layers. If set to '', the layer will be inserted above
| every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
| l` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmapbox.Legendgro
| uptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmapbox.Unselecte
| d` instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_cone(self, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Cone trace
|
| Use cone traces to visualize vector fields. Specify a vector
| field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and
| 3 vector component arrays `u`, `v`, `w`. The cones are drawn
| exactly at the positions given by `x`, `y` and `z`.
|
| Parameters
| ----------
| anchor
| Sets the cones' anchor with respect to their x/y/z
| positions. Note that "cm" denote the cone's center of
| mass which corresponds to 1/4 from the tail to tip.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.cone.ColorBar` instance or
| dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.cone.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `norm` Anything contained in tag `<extra>`
| is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.cone.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.cone.Lighting` instance or
| dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.cone.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in
| the vector field) or as "absolute" value (in the same
| units as the vector field). To display sizes in actual
| vector length use "raw".
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally)
| corresponds to the minimum "time" to travel across two
| successive x/y/z positions at the average velocity of
| those two successive positions. All cones in a given
| trace use the same factor. With `sizemode` set to
| "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is
| 0.5. With `sizemode` set to "absolute", `sizeref` has
| the same units as the u/v/w vector field, its the
| default value is half the sample's maximum vector norm.
| stream
| :class:`plotly.graph_objects.cone.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the cones. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_contour(self, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Contour trace
|
| The data from which contour lines are computed is set in `z`.
| Data in `z` must be a 2D list of numbers. Say that `z` has N
| rows and M columns, then by default, these N rows correspond to
| N y coordinates (set in `y` or auto-generated) and the M
| columns correspond to M x coordinates (set in `x` or auto-
| generated). By setting `transpose` to True, the above behavior
| is flipped.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contour.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array otherwise it
| is defaulted to false.
| contours
| :class:`plotly.graph_objects.contour.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.contour.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contour.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contour.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contour.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| 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, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Contourcarpet trace
|
| Plots contours on either the first carpet axis or the carpet
| axis with a matching `carpet` attribute. Data `z` is
| interpreted as matching that of the corresponding carpet axis.
|
| Parameters
| ----------
| a
| Sets the x coordinates.
| a0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| atype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| b
| Sets the y coordinates.
| b0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| btype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| carpet
| The `carpet` of the carpet axes on which this contour
| trace lies
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contourcarpet.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.contourcarpet.Contours`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the x coordinate step. See `x0` for more info.
| db
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contourcarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contourcarpet.Line`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contourcarpet.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_densitymap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Densitymap trace
|
| Draws a bivariate kernel density estimation with a Gaussian
| kernel from `lon` and `lat` coordinates and optional `z` values
| using a colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymap trace will be inserted
| before the layer with the specified ID. By default,
| densitymap traces are placed below the first layer of
| type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymap
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_densitymapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Densitymapbox trace
|
| "densitymapbox" trace is deprecated! Please consider switching
| to the "densitymap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ Draws a
| bivariate kernel density estimation with a Gaussian kernel from
| `lon` and `lat` coordinates and optional `z` values using a
| colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymapbox trace will be inserted
| before the layer with the specified ID. By default,
| densitymapbox traces are placed below the first layer
| of type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymapbox
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_funnel(self, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Funnel trace
|
| Visualize stages in a process using length-encoded bars. This
| trace can be used to show data in either a part-to-whole
| representation wherein each item appears in a single stage, or
| in a "drop-off" representation wherein each item appears in
| each stage it traversed. See also the "funnelarea" trace type
| for a different approach to visualizing funnel data.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.funnel.Connector` instance
| or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnel.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious` and
| `percentTotal`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnel.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnel.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the funnels. With "v" ("h"),
| the value of the each bar spans along the vertical
| (horizontal). By default funnels are tend to be
| oriented horizontally; unless only "y" array is
| presented or orientation is set to "v". Also regarding
| graphs including only 'horizontal' funnels, "autorange"
| on the "y-axis" are set to "reversed".
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnel.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple funnels, percentages &
| totals are computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious`,
| `percentTotal`, `label` and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_funnelarea(self, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Funnelarea trace
|
| Visualize stages in a process using area-encoded trapezoids.
| This trace can be used to show data in a part-to-whole
| representation similar to a "pie" trace, wherein each item
| appears in a single stage. See also the "funnel" trace type for
| a different approach to visualizing funnel data.
|
| Parameters
| ----------
| aspectratio
| Sets the ratio between height and width
| baseratio
| Sets the ratio between bottom length and maximum top
| length.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.funnelarea.Domain`
| instance or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnelarea.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnelarea.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnelarea.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnelarea.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.funnelarea.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_heatmap(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Heatmap trace
|
| The data that describes the heatmap value-to-color mapping is
| set in `z`. Data in `z` can either be a 2D list of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a 2D list, say that `z` has N rows and M columns. Then, by
| default, the resulting heatmap will have N partitions along the
| y axis and M partitions along the x axis. In other words, the
| i-th row/ j-th column cell in `z` is mapped to the i-th
| partition of the y axis (starting from the bottom of the plot)
| and the j-th partition of the x-axis (starting from the left of
| the plot). This behavior can be flipped by using `transpose`.
| Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1)
| elements. If M (N), then the coordinates correspond to the
| center of the heatmap cells and the cells have equal width. If
| M+1 (N+1), then the coordinates correspond to the edges of the
| heatmap cells. In the case where `z` is a 1D list, the x and y
| coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmap.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array and `zsmooth`
| is not false; otherwise it is defaulted to false.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmap.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmap.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_heatmapgl(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Heatmapgl trace
|
| "heatmapgl" trace is deprecated! Please consider switching to
| the "heatmap" or "image" trace types. Alternatively you could
| contribute/sponsor rewriting this trace type based on cartesian
| features and using regl framework. WebGL version of the heatmap
| trace type.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmapgl.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmapgl.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmapgl.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_histogram(self, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Histogram trace
|
| The sample data from which statistics are computed is set in
| `x` for vertically spanning histograms and in `y` for
| horizontally spanning histograms. Binning options are set
| `xbins` and `ybins` respectively if no aggregation data is
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| bingroup
| Set a group of histogram traces which will have
| compatible bin settings. Note that traces on the same
| subplot and with the same "orientation" under `barmode`
| "stack", "relative" and "group" are forced into the
| same bingroup, Using `bingroup`, traces under `barmode`
| "overlay" and on different axes (of the same axis type)
| can have compatible bin settings. Note that histogram
| and histogram2d* trace can share the same `bingroup`
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| cumulative
| :class:`plotly.graph_objects.histogram.Cumulative`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.histogram.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.histogram.ErrorY` instance
| or dict with compatible properties
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `binNumber` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.histogram.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.histogram.Stream` instance
| or dict with compatible properties
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the text font.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label` and `value`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.histogram.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbins
| :class:`plotly.graph_objects.histogram.XBins` instance
| or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybins
| :class:`plotly.graph_objects.histogram.YBins` instance
| or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_histogram2d(self, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Histogram2d trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a heatmap.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2d.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2d.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram2d.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2d.Stream`
| instance or dict with compatible properties
| textfont
| Sets the text font.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z`
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2d.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2d.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_histogram2dcontour(self, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Histogram2dContour trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a contour plot.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2dcontour.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.histogram2dcontour.Contour
| s` instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2dcontour.Hoverla
| bel` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2dcontour.Legendg
| rouptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.histogram2dcontour.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.histogram2dcontour.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2dcontour.Stream`
| instance or dict with compatible properties
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2dcontour.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2dcontour.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_hline(self, y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a horizontal line to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y: float or int
| A number representing the y coordinate of the horizontal line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_hrect(self, y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a rectangle to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y0: float or int
| A number representing the y coordinate of one side of the rectangle.
| y1: float or int
| A number representing the y coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_icicle(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Icicle trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The icicle sectors are determined
| by the entries in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.icicle.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.icicle.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.icicle.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.icicle.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.icicle.Marker` instance or
| dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.icicle.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.icicle.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.icicle.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.icicle.Tiling` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_image(self, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Image trace
|
| Display an image, i.e. data on a 2D regular raster. By default,
| when an image is displayed in a subplot, its y axis will be
| reversed (ie. `autorange: 'reversed'`), constrained to the
| domain (ie. `constrain: 'domain'`) and it will have the same
| scale as its x axis (ie. `scaleanchor: 'x,`) in order for
| pixels to be rendered as squares.
|
| Parameters
| ----------
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified,
| this attribute will be set to `rgba256` otherwise it
| defaults to `rgb`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Set the pixel's horizontal size.
| dy
| Set the pixel's vertical size
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.image.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `z`, `color` and `colormodel`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.image.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| source
| Specifies the data URI of the image to be visualized.
| The URI consists of "data:image/[<media
| subtype>][;base64],<data>"
| stream
| :class:`plotly.graph_objects.image.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Set the image's x position. The left edge of the image
| (or the right edge if the x axis is reversed or dx is
| negative) will be found at xmin=x0-dx/2
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| y0
| Set the image's y position. The top edge of the image
| (or the bottom edge if the y axis is NOT reversed or if
| dy is negative) will be found at ymin=y0-dy/2. By
| default when an image trace is included, the y axis
| will be reversed so that the image is right-side-up,
| but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis
| range.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| A 2-dimensional array in which each element is an array
| of 3 or 4 numbers representing a color.
| zmax
| Array defining the higher bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [255,
| 255, 255]. For the `rgba` colormodel, it is [255, 255,
| 255, 1]. For the `rgba256` colormodel, it is [255, 255,
| 255, 255]. For the `hsl` colormodel, it is [360, 100,
| 100]. For the `hsla` colormodel, it is [360, 100, 100,
| 1].
| zmin
| Array defining the lower bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [0, 0,
| 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For
| the `rgba256` colormodel, it is [0, 0, 0, 0]. For the
| `hsl` colormodel, it is [0, 0, 0]. For the `hsla`
| colormodel, it is [0, 0, 0, 0].
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data.
| This only applies for image traces that use the
| `source` attribute.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_indicator(self, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Indicator trace
|
| An indicator is used to visualize a single `value` along with
| some contextual information such as `steps` or a `threshold`,
| using a combination of three visual elements: a number, a
| delta, and/or a gauge. Deltas are taken with respect to a
| `reference`. Gauges can be either angular or bullet (aka
| linear) gauges.
|
| Parameters
| ----------
| align
| Sets the horizontal alignment of the `text` within the
| box. Note that this attribute has no effect if an
| angular gauge is displayed: in this case, it is always
| centered
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delta
| :class:`plotly.graph_objects.indicator.Delta` instance
| or dict with compatible properties
| domain
| :class:`plotly.graph_objects.indicator.Domain` instance
| or dict with compatible properties
| gauge
| The gauge of the Indicator plot.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.indicator.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines how the value is displayed on the graph.
| `number` displays the value numerically in text.
| `delta` displays the difference to a reference value in
| text. Finally, `gauge` displays the value graphically
| on an axis.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| number
| :class:`plotly.graph_objects.indicator.Number` instance
| or dict with compatible properties
| stream
| :class:`plotly.graph_objects.indicator.Stream` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.indicator.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the number to be displayed.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_isosurface(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Isosurface trace
|
| Draws isosurfaces between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.isosurface.Caps` instance
| or dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.isosurface.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.isosurface.Contour`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.isosurface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.isosurface.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.isosurface.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.isosurface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.isosurface.Slices`
| instance or dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.isosurface.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.isosurface.Stream`
| instance or dict with compatible properties
| surface
| :class:`plotly.graph_objects.isosurface.Surface`
| instance or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_layout_image(self, arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new image to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Image or dict with compatible properties
| layer
| Specifies whether images are drawn below or above
| traces. When `xref` and `yref` are both set to `paper`,
| image is drawn below the entire plot area.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the image.
| sizex
| Sets the image container size horizontally. The image
| will be sized based on the `position` value. When
| `xref` is set to `paper`, units are sized relative to
| the plot width. When `xref` ends with ` domain`, units
| are sized relative to the axis width.
| sizey
| Sets the image container size vertically. The image
| will be sized based on the `position` value. When
| `yref` is set to `paper`, units are sized relative to
| the plot height. When `yref` ends with ` domain`, units
| are sized relative to the axis height.
| sizing
| Specifies which dimension of the image to constrain.
| source
| Specifies the URL of the image to be used. The URL must
| be accessible from the domain where the plot code is
| run, and can be either relative or absolute.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| visible
| Determines whether or not this image is visible.
| x
| Sets the image's x position. When `xref` is set to
| `paper`, units are sized relative to the plot height.
| See `xref` for more info
| xanchor
| Sets the anchor for the x position
| xref
| Sets the images's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y
| Sets the image's y position. When `yref` is set to
| `paper`, units are sized relative to the plot height.
| See `yref` for more info
| yanchor
| Sets the anchor for the y position.
| yref
| Sets the images's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for image. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for image. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add image to secondary y-axis
| exclude_empty_subplots
| If True, image will not be added to subplots without
| traces.
|
| Returns
| -------
| FigureWidget
|
| add_mesh3d(self, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Mesh3d trace
|
| Draws sets of triangles with coordinates given by three
| 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`,
| `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-
| shape algorithm or (4) the Convex-hull algorithm
|
| Parameters
| ----------
| alphahull
| Determines how the mesh surface triangles are derived
| from the set of vertices (points) represented by the
| `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays
| are not supplied. For general use of `mesh3d` it is
| preferred that `i`, `j`, `k` are supplied. If "-1",
| Delaunay triangulation is used, which is mainly
| suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In
| case the `delaunayaxis` intersects the mesh surface at
| more than one point it will result triangles that are
| very long in the dimension of `delaunayaxis`. If ">0",
| the alpha-shape algorithm is used. In this case, the
| positive `alphahull` value signals the use of the
| alpha-shape algorithm, _and_ its value acts as the
| parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or
| if the intention is to enclose the `x`, `y` and `z`
| point set into a convex hull.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `intensity`) or
| the bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `intensity`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmax`
| must be set as well.
| color
| Sets the color of the whole mesh
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.mesh3d.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.mesh3d.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is
| perpendicular to the surface of the Delaunay
| triangulation. It has an effect if `i`, `j`, `k` are
| not provided and `alphahull` is set to indicate
| Delaunay triangulation.
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.mesh3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| i
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "first" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `i[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `i` represents a point in space, which
| is the first vertex of a triangle.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| intensity
| Sets the intensity values for vertices or cells as
| defined by `intensitymode`. It can be used for plotting
| fields on meshes.
| intensitymode
| Determines the source of `intensity` values.
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
| isrc
| Sets the source reference on Chart Studio Cloud for
| `i`.
| j
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "second" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `j[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `j` represents a point in space, which
| is the second vertex of a triangle.
| jsrc
| Sets the source reference on Chart Studio Cloud for
| `j`.
| k
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "third" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `k[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `k` represents a point in space, which
| is the third vertex of a triangle.
| ksrc
| Sets the source reference on Chart Studio Cloud for
| `k`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.mesh3d.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.mesh3d.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.mesh3d.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.mesh3d.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| vertexcolor
| Sets the color of each vertex Overrides "color". While
| Red, green and blue colors are in the range of 0 and
| 255; in the case of having vertex color data in RGBA
| format, the alpha color should be normalized to be
| between 0 and 1.
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_ohlc(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Ohlc trace
|
| The ohlc (short for Open-High-Low-Close) is a style of
| financial chart describing open, high, low and close for a
| given `x` coordinate (most likely time). The tip of the lines
| represent the `low` and `high` values and the horizontal
| segments represent the `open` and `close` values. Sample points
| where the close value is higher (lower) then the open value are
| called increasing (decreasing). By default, increasing items
| are drawn in green whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.ohlc.Decreasing` instance
| or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.ohlc.Hoverlabel` instance
| or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.ohlc.Increasing` instance
| or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.ohlc.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.ohlc.Line` instance or
| dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.ohlc.Stream` instance or
| dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| tickwidth
| Sets the width of the open/close tick marks relative to
| the "x" minimal interval.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_parcats(self, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Parcats trace
|
| Parallel categories diagram for multidimensional categorical
| data.
|
| Parameters
| ----------
| arrangement
| Sets the drag interaction mode for categories and
| dimensions. If `perpendicular`, the categories can only
| move along a line perpendicular to the paths. If
| `freeform`, the categories can freely move on the
| plane. If `fixed`, the categories and dimensions are
| stationary.
| bundlecolors
| Sort paths so that like colors are bundled together
| within each category.
| counts
| The number of observations represented by each state.
| Defaults to 1 so that each state represents one
| observation
| countssrc
| Sets the source reference on Chart Studio Cloud for
| `counts`.
| dimensions
| The dimensions (variables) of the parallel categories
| diagram.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets
| the default property values to use for elements of
| parcats.dimensions
| domain
| :class:`plotly.graph_objects.parcats.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoveron
| Sets the hover interaction mode for the parcats
| diagram. If `category`, hover interaction take place
| per category. If `color`, hover interactions take place
| per color per category. If `dimension`, hover
| interactions take place across all categories per
| dimension.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. This value here applies when hovering
| over dimensions. Note that `*categorycount`,
| "colorcount" and "bandcolorcount" are only available
| when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`,
| `probability`, `category`, `categorycount`,
| `colorcount` and `bandcolorcount`. Anything contained
| in tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| labelfont
| Sets the font for the `dimension` labels.
| legendgrouptitle
| :class:`plotly.graph_objects.parcats.Legendgrouptitle`
| instance or dict with compatible properties
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcats.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort
| paths based on dimension categories from left to right.
| If `backward`, sort paths based on dimensions
| categories from right to left.
| stream
| :class:`plotly.graph_objects.parcats.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `category` labels.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_parcoords(self, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Parcoords trace
|
| Parallel coordinates for multidimensional exploratory data
| analysis. The samples are specified in `dimensions`. The colors
| are set in `line.color`.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets
| the default property values to use for elements of
| parcoords.dimensions
| domain
| :class:`plotly.graph_objects.parcoords.Domain` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| labelangle
| Sets the angle of the labels with respect to the
| horizontal. For example, a `tickangle` of -90 draws the
| labels vertically. Tilted labels with "labelangle" may
| be positioned better inside margins when
| `labelposition` is set to "bottom".
| labelfont
| Sets the font for the `dimension` labels.
| labelside
| Specifies the location of the `label`. "top" positions
| labels above, next to the title "bottom" positions
| labels below the graph Tilted labels with "labelangle"
| may be positioned better inside margins when
| `labelposition` is set to "bottom".
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.parcoords.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcoords.Line` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| rangefont
| Sets the font for the `dimension` range values.
| stream
| :class:`plotly.graph_objects.parcoords.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.parcoords.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_pie(self, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Pie trace
|
| A data visualized by the sectors of the pie is set in `values`.
| The sector labels are set in `labels`. The sector colors are
| set in `marker.colors`
|
| Parameters
| ----------
| automargin
| Determines whether outside text labels can push the
| margins.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| direction
| Specifies the direction at which succeeding sectors
| follow one another.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.pie.Domain` instance or
| dict with compatible properties
| hole
| Sets the fraction of the radius to cut out of the pie.
| Use this to make a donut chart.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pie.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pie.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pie.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector.
| pull
| Sets the fraction of larger radius to pull the sectors
| out from the center. This can be a constant to pull all
| slices apart from each other equally or an array to
| highlight one or more slices.
| pullsrc
| Sets the source reference on Chart Studio Cloud for
| `pull`.
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pie charts that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.pie.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.pie.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the
| font used for `title`. Note that the title's font used
| to be set by the now deprecated `titlefont` attribute.
| titleposition
| Deprecated: Please use pie.title.position instead.
| Specifies the location of the `title`. Note that the
| title's position used to be set by the now deprecated
| `titleposition` attribute.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_pointcloud(self, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Pointcloud trace
|
| "pointcloud" trace is deprecated! Please consider switching to
| the "scattergl" trace type. The data visualized as a point
| cloud set in `x` and `y` using the WebGl plotting engine.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pointcloud.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| indices
| A sequential value, 0..n, supply it to avoid creating
| this array inside plotting. If specified, it must be a
| typed `Int32Array` array. Its length must be equal to
| or greater than the number of points. For the best
| performance and memory use, create one large `indices`
| typed array that is guaranteed to be at least as long
| as the largest number of points during use, and reuse
| it on each `Plotly.restyle()` call.
| indicessrc
| Sets the source reference on Chart Studio Cloud for
| `indices`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pointcloud.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pointcloud.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.pointcloud.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `ybounds` for the performance
| benefits.
| xboundssrc
| Sets the source reference on Chart Studio Cloud for
| `xbounds`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xy
| Faster alternative to specifying `x` and `y`
| separately. If supplied, it must be a typed
| `Float32Array` array that represents points such that
| `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`
| xysrc
| Sets the source reference on Chart Studio Cloud for
| `xy`.
| y
| Sets the y coordinates.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `xbounds` for the performance
| benefits.
| yboundssrc
| Sets the source reference on Chart Studio Cloud for
| `ybounds`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_sankey(self, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Sankey trace
|
| Sankey plots for network flow data analysis. The nodes are
| specified in `nodes` and the links between sources and targets
| in `links`. The colors are set in `nodes[i].color` and
| `links[i].color`, otherwise defaults are used.
|
| Parameters
| ----------
| arrangement
| If value is `snap` (the default), the node arrangement
| is assisted by automatic snapping of elements to
| preserve space between nodes specified via `nodepad`.
| If value is `perpendicular`, the nodes can only move
| along a line perpendicular to the flow. If value is
| `freeform`, the nodes can freely move on the plane. If
| value is `fixed`, the nodes are stationary.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sankey.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired. Note that this attribute is
| superseded by `node.hoverinfo` and `node.hoverinfo` for
| nodes and links respectively.
| hoverlabel
| :class:`plotly.graph_objects.sankey.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sankey.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| link
| The links of the Sankey plot.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| orientation
| Sets the orientation of the Sankey diagram.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| stream
| :class:`plotly.graph_objects.sankey.Stream` instance or
| dict with compatible properties
| textfont
| Sets the font for node labels
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| valuesuffix
| Adds a unit to follow the value in the hover tooltip.
| Add a space if a separation is necessary from the
| value.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scatter(self, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Scatter trace
|
| The scatter trace type encompasses line charts, scatter charts,
| text charts, and bubble charts. The data visualized as scatter
| point or lines is set in `x` and `y`. Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scatter.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available. If fillgradient is
| specified, fillcolor is ignored except for setting the
| background color of the hover label, if any.
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor
| is used instead.
| fillpattern
| Sets the pattern within the marker.
| groupnorm
| Only relevant when `stackgroup` is used, and only the
| first `groupnorm` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Sets the normalization for the sum of
| this `stackgroup`. With "fraction", the value of each
| trace at each location is divided by the sum of all
| trace values at that location. "percent" is the same
| but multiplied by 100 to show percentages. If there are
| multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Only relevant in the following cases: 1. when
| `scattermode` is set to "group". 2. when `stackgroup`
| is used, and only the first `orientation` found in the
| `stackgroup` will be used - including if `visible` is
| "legendonly" but not if it is `false`. Sets the
| stacking direction. With "v" ("h"), the y (x) values of
| subsequent traces are added. Also affects the default
| value of `fill`.
| selected
| :class:`plotly.graph_objects.scatter.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stackgaps
| Only relevant when `stackgroup` is used, and only the
| first `stackgaps` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Determines how we handle locations at
| which other traces in this group have data but this one
| does not. With *infer zero* we insert a zero at these
| locations. With "interpolate" we linearly interpolate
| between existing values, and extrapolate a constant
| beyond the existing values.
| stackgroup
| Set several scatter traces (on the same subplot) to the
| same stackgroup in order to add their y values (or
| their x values if `orientation` is "h"). If blank or
| omitted this trace will not be stacked. Stacking also
| turns `fill` on by default, using "tonexty" ("tonextx")
| if `orientation` is "h" ("v") and sets the default
| `mode` to "lines" irrespective of point count. You can
| only stack on a numeric (linear or log) axis. Traces in
| a `stackgroup` will only fill to (or be filled to)
| other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if
| fill-linked traces are not already consecutive, the
| later ones will be pushed down in the drawing order.
| stream
| :class:`plotly.graph_objects.scatter.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatter.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_scatter3d(self, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatter3d trace
|
| The data visualized as scatter point or lines in 3D dimension
| is set in `x`, `y`, `z`. Text (appearing either on the chart or
| on hover only) is via `text`. Bubble charts are achieved by
| setting `marker.size` and/or `marker.color` Projections are
| achieved via `projection`. Surface fills are achieved via
| `surfaceaxis`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.scatter3d.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter3d.ErrorY` instance
| or dict with compatible properties
| error_z
| :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter3d.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter3d.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| projection
| :class:`plotly.graph_objects.scatter3d.Projection`
| instance or dict with compatible properties
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatter3d.Stream` instance
| or dict with compatible properties
| surfaceaxis
| If "-1", the scatter points are not fill with a surface
| If 0, 1, 2, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Scattercarpet trace
|
| Plots a scatter trace on either the first carpet axis or the
| carpet axis with a matching `carpet` attribute.
|
| Parameters
| ----------
| a
| Sets the a-axis coordinates.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the b-axis coordinates.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattercarpet.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b). To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattercarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattercarpet.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattercarpet.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattercarpet.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattercarpet.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (a,b) point. If
| a single string, the same string appears over all the
| data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattercarpet.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_scattergeo(self, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattergeo trace
|
| The data visualized as scatter point or lines on a geographic
| map is provided either by longitude/latitude pairs in `lon` and
| `lat` respectively or by geographic location IDs or names in
| `locations`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used
| when `locations` is set. It can be set as a valid
| GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or
| "Feature" with geometries of type "Polygon" or
| "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergeo.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair or item in `locations`. If a single string, the
| same string appears over all the data points. If an
| array of string, the items are mapped in order to the
| this trace's (lon,lat) or `locations` coordinates. To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergeo.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergeo.Line` instance
| or dict with compatible properties
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names.
| Coordinates correspond to the centroid of each location
| given. See `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattergeo.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergeo.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergeo.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (lon,lat) pair
| or item in `locations`. If a single string, the same
| string appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (lon,lat) or `locations` coordinates. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is
| not set, these elements will be seen in the hover
| labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon`, `location` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergeo.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Scattergl trace
|
| The data visualized as scatter point or lines is set in `x` and
| `y` using the WebGL plotting engine. Bubble charts are achieved
| by setting `marker.size` and/or `marker.color` to a numerical
| arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scattergl.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scattergl.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergl.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattergl.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergl.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_scattermap(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattermap trace
|
| The data visualized as scatter point, lines or marker symbols
| on a MapLibre GL geographic map is provided by
| longitude/latitude pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermap trace's layers are to be
| inserted before the layer with the specified ID. By
| default, scattermap layers are inserted above all the
| base layers. To place the scattermap layers above every
| other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermap.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermap.Line` instance
| or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=map.layer.paint.text-
| color, size=map.layer.layout.text-size). Has an effect
| only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scattermapbox(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattermapbox trace
|
| "scattermapbox" trace is deprecated! Please consider switching
| to the "scattermap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ The data
| visualized as scatter point, lines or marker symbols on a
| Mapbox GL geographic map is provided by longitude/latitude
| pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermapbox trace's layers are to
| be inserted before the layer with the specified ID. By
| default, scattermapbox layers are inserted above all
| the base layers. To place the scattermapbox layers
| above every other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermapbox.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermapbox.Line`
| instance or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-
| color, size=mapbox.layer.layout.text-size). Has an
| effect only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermapbox.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scatterpolar(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatterpolar trace
|
| The scatterpolar trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in polar coordinates.
| The data visualized as scatter point or lines is set in `r`
| (radial) and `theta` (angular) coordinates Text (appearing
| either on the chart or on hover only) is via `text`. Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterpolar has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolar.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolar.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolar.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolar.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolar.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scatterpolargl(self, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatterpolargl trace
|
| The scatterpolargl trace type encompasses line charts, scatter
| charts, and bubble charts in polar coordinates using the WebGL
| plotting engine. The data visualized as scatter point or lines
| is set in `r` (radial) and `theta` (angular) coordinates Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolargl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolargl.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolargl.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolargl.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolargl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolargl.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolargl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scattersmith(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattersmith trace
|
| The scattersmith trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in smith coordinates.
| The data visualized as scatter point or lines is set in `real`
| and `imag` (imaginary) coordinates Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scattersmith has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattersmith.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| imagsrc
| Sets the source reference on Chart Studio Cloud for
| `imag`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattersmith.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattersmith.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattersmith.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| real
| Sets the real component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| realsrc
| Sets the source reference on Chart Studio Cloud for
| `real`.
| selected
| :class:`plotly.graph_objects.scattersmith.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattersmith.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a smith subplot. If "smith" (the default value),
| the data refer to `layout.smith`. If "smith2", the data
| refer to `layout.smith2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `real`, `imag` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattersmith.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatterternary trace
|
| Provides similar functionality to the "scatter" type but on a
| ternary phase diagram. The data is provided by at least two
| arrays out of `a`, `b`, `c` triplets.
|
| Parameters
| ----------
| a
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on Chart Studio Cloud for
| `c`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterternary.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b,c)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b,c).
| To be seen, trace `hoverinfo` must contain a "text"
| flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterternary.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterternary.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterternary.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scatterternary.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterternary.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If "ternary" (the default
| value), the data refer to `layout.ternary`. If
| "ternary2", the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b`, `c` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterternary.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_selection(self, arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new selection to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Selection or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.layout.selection.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the selection.
| path
| For `type` "path" - a valid SVG path similar to
| `shapes.path` in data coordinates. Allowed segments
| are: M, L and Z.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the selection type to be drawn. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom
| SVG path using `path`.
| x0
| Sets the selection's starting x position.
| x1
| Sets the selection's end x position.
| xref
| Sets the selection's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y0
| Sets the selection's starting y position.
| y1
| Sets the selection's end y position.
| yref
| Sets the selection's x coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for selection. If 'all', addresses all rows
| in the specified column(s).
| col
| Subplot column for selection. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add selection to secondary y-axis
| exclude_empty_subplots
| If True, selection will not be added to subplots
| without traces.
|
| Returns
| -------
| FigureWidget
|
| add_shape(self, arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new shape to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Shape or dict with compatible properties
| editable
| Determines whether the shape could be activated for
| edit or not. Has no effect when the older editable
| shapes mode is enabled via `config.editable` or
| `config.edits.shapePosition`.
| fillcolor
| Sets the color filling the shape's interior. Only
| applies to closed shapes.
| fillrule
| Determines which regions of complex paths constitute
| the interior. For more info please visit
| https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.shape.Label`
| instance or dict with compatible properties
| layer
| Specifies whether shapes are drawn below gridlines
| ("below"), between gridlines and traces ("between") or
| above traces ("above").
| legend
| Sets the reference to a legend to show this shape in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this shape. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.shape.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this shape. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this shape.
| line
| :class:`plotly.graph_objects.layout.shape.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the shape.
| path
| For `type` "path" - a valid SVG path with the pixel
| values replaced by data values in
| `xsizemode`/`ysizemode` being "scaled" and taken
| unmodified as pixels relative to `xanchor` and
| `yanchor` in case of "pixel" size mode. There are a few
| restrictions / quirks only absolute instructions, not
| relative. So the allowed segments are: M, L, H, V, Q,
| C, T, S, and Z arcs (A) are not allowed because radius
| rx and ry are relative. In the future we could consider
| supporting relative commands, but we would have to
| decide on how to handle date and log axes. Note that
| even as is, Q and C Bezier paths that are smooth on
| linear axes may not be smooth on log, and vice versa.
| no chained "polybezier" commands - specify the segment
| type for each one. On category axes, values are numbers
| scaled to the serial numbers of categories because
| using the categories themselves there would be no way
| to describe fractional positions On data axes: because
| space and T are both normal components of path strings,
| we can't use either to separate date from time parts.
| Therefore we'll use underscore for this purpose:
| 2015-02-21_13:45:56.789
| showlegend
| Determines whether or not this shape is shown in the
| legend.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the shape type to be drawn. If "line", a line
| is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect
| to the axes' sizing mode. If "circle", a circle is
| drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius
| (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with
| respect to the axes' sizing mode. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to
| the axes' sizing mode. If "path", draw a custom SVG
| path using `path`. with respect to the axes' sizing
| mode.
| visible
| Determines whether or not this shape is visible. If
| "legendonly", the shape is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Sets the shape's starting x position. See `type` and
| `xsizemode` for more info.
| x0shift
| Shifts `x0` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| x1
| Sets the shape's end x position. See `type` and
| `xsizemode` for more info.
| x1shift
| Shifts `x1` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| xanchor
| Only relevant in conjunction with `xsizemode` set to
| "pixel". Specifies the anchor point on the x axis to
| which `x0`, `x1` and x coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `xsizemode` not
| set to "pixel".
| xref
| Sets the shape's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xsizemode
| Sets the shapes's sizing mode along the x axis. If set
| to "scaled", `x0`, `x1` and x coordinates within `path`
| refer to data values on the x axis or a fraction of the
| plot area's width (`xref` set to "paper"). If set to
| "pixel", `xanchor` specifies the x position in terms of
| data or plot fraction but `x0`, `x1` and x coordinates
| within `path` are pixels relative to `xanchor`. This
| way, the shape can have a fixed width while maintaining
| a position relative to data or plot fraction.
| y0
| Sets the shape's starting y position. See `type` and
| `ysizemode` for more info.
| y0shift
| Shifts `y0` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| y1
| Sets the shape's end y position. See `type` and
| `ysizemode` for more info.
| y1shift
| Shifts `y1` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| yanchor
| Only relevant in conjunction with `ysizemode` set to
| "pixel". Specifies the anchor point on the y axis to
| which `y0`, `y1` and y coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `ysizemode` not
| set to "pixel".
| yref
| Sets the shape's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| ysizemode
| Sets the shapes's sizing mode along the y axis. If set
| to "scaled", `y0`, `y1` and y coordinates within `path`
| refer to data values on the y axis or a fraction of the
| plot area's height (`yref` set to "paper"). If set to
| "pixel", `yanchor` specifies the y position in terms of
| data or plot fraction but `y0`, `y1` and y coordinates
| within `path` are pixels relative to `yanchor`. This
| way, the shape can have a fixed height while
| maintaining a position relative to data or plot
| fraction.
| row
| Subplot row for shape. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for shape. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add shape to secondary y-axis
| exclude_empty_subplots
| If True, shape will not be added to subplots without
| traces.
|
| Returns
| -------
| FigureWidget
|
| add_splom(self, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Splom trace
|
| Splom traces generate scatter plot matrix visualizations. Each
| splom `dimensions` items correspond to a generated axis. Values
| for each of those dimensions are set in `dimensions[i].values`.
| Splom traces support all `scattergl` marker style attributes.
| Specify `layout.grid` attributes and/or layout x-axis and
| y-axis attributes for more control over the axis positioning
| and style.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| diagonal
| :class:`plotly.graph_objects.splom.Diagonal` instance
| or dict with compatible properties
| dimensions
| A tuple of
| :class:`plotly.graph_objects.splom.Dimension` instances
| or dicts with compatible properties
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the
| default property values to use for elements of
| splom.dimensions
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.splom.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.splom.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.splom.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.splom.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showlowerhalf
| Determines whether or not subplots on the lower half
| from the diagonal are displayed.
| showupperhalf
| Determines whether or not subplots on the upper half
| from the diagonal are displayed.
| stream
| :class:`plotly.graph_objects.splom.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair to
| appear on hover. If a single string, the same string
| appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.splom.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxes
| Sets the list of x axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N xaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| yaxes
| Sets the list of y axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N yaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_streamtube(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Streamtube trace
|
| Use a streamtube trace to visualize flow in a vector field.
| Specify a vector field using 6 1D arrays of equal length, 3
| position arrays `x`, `y` and `z` and 3 vector component arrays
| `u`, `v`, and `w`. By default, the tubes' starting positions
| will be cut from the vector field's x-z plane at its minimum y
| value. To specify your own starting position, use attributes
| `starts.x`, `starts.y` and `starts.z`. The color is encoded by
| the norm of (u, v, w), and the local radius by the divergence
| of (u, v, w).
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.streamtube.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.streamtube.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `tubex`, `tubey`, `tubez`, `tubeu`,
| `tubev`, `tubew`, `norm` and `divergence`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.streamtube.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.streamtube.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.streamtube.Lightposition`
| instance or dict with compatible properties
| maxdisplayed
| The maximum number of displayed segments in a
| streamtube.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizeref
| The scaling factor for the streamtubes. The default is
| 1, which avoids two max divergence tubes from touching
| at adjacent starting positions.
| starts
| :class:`plotly.graph_objects.streamtube.Starts`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.streamtube.Stream`
| instance or dict with compatible properties
| text
| Sets a text element associated with this trace. If
| trace `hoverinfo` contains a "text" flag, this text
| element will be seen in all hover labels. Note that
| streamtube traces do not support array `text` values.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_sunburst(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Sunburst trace
|
| Visualize hierarchal data spanning outward radially from root
| to leaves. The sunburst sectors are determined by the entries
| in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sunburst.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.sunburst.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.sunburst.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sunburst.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.sunburst.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented at the center of a sunburst graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| root
| :class:`plotly.graph_objects.sunburst.Root` instance or
| dict with compatible properties
| rotation
| Rotates the whole diagram counterclockwise by some
| angle. By default the first slice starts at 3 o'clock.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.sunburst.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_surface(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Surface trace
|
| The data the describes the coordinates of the surface is set in
| `z`. Data in `z` should be a 2D list. Coordinates in `x` and
| `y` can either be 1D lists or 2D lists (e.g. to graph
| parametric surfaces). If not provided in `x` and `y`, the x and
| y coordinates are assumed to be linear starting at 0 with a
| unit step. The color scale corresponds to the `z` values by
| default. For custom color scales, use `surfacecolor` which
| should be a 2D list, where its bounds can be controlled using
| `cmin` and `cmax`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here z or surfacecolor)
| or the bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as z or surfacecolor.
| Has no effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmax` must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.surface.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| :class:`plotly.graph_objects.surface.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hidesurface
| Determines whether or not a surface is drawn. For
| example, set `hidesurface` to False `contours.x.show`
| to True and `contours.y.show` to True to draw a wire
| frame plot.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.surface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.surface.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.surface.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.surface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.surface.Stream` instance
| or dict with compatible properties
| surfacecolor
| Sets the surface color values, used for setting a color
| scale independent of `z`.
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
| text
| Sets the text elements associated with each z value. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Table trace
|
| Table view for detailed data viewing. The data are arranged in
| a grid of rows and columns. Most styling can be specified for
| columns, rows or individual cells. Table is using a column-
| major order, ie. the grid is represented as a vector of column
| vectors.
|
| Parameters
| ----------
| cells
| :class:`plotly.graph_objects.table.Cells` instance or
| dict with compatible properties
| columnorder
| Specifies the rendered order of the data columns; for
| example, a value `2` at position `0` means that column
| index `0` in the data will be rendered as the third
| column, as columns have an index base of zero.
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
| columnwidth
| The width of columns expressed as a ratio. Columns fill
| the available width in proportion of their specified
| column widths.
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.table.Domain` instance or
| dict with compatible properties
| header
| :class:`plotly.graph_objects.table.Header` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.table.Hoverlabel` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.table.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| stream
| :class:`plotly.graph_objects.table.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_trace(self, trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) -> 'FigureWidget'
| 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 : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
| * The trace argument is a 2D cartesian trace
| (scatter, bar, etc.)
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
| Returns
| -------
| BaseFigure
| The Figure that add_trace was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS
| Figure(...)
|
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) # doctest: +ELLIPSIS
| Figure(...)
|
| add_traces(self, data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) -> 'FigureWidget'
| Add traces to the figure
|
| Parameters
| ----------
| data : list[BaseTraceType or dict]
| A list of trace specifications to be added.
| Trace specifications may be either:
|
| - Instances of trace classes from the plotly.graph_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, list[int], or int (default None)
| List of subplot row indexes (starting from 1) for the traces to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to row number
|
| cols : None or list[int] (default None)
| List of subplot column indexes (starting from 1) for the traces
| to be added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to column number
|
|
| secondary_ys: None or list[boolean] (default None)
| List of secondary_y booleans for traces to be added. See the
| docstring for `add_trace` for more info.
|
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
|
| Returns
| -------
| BaseFigure
| The Figure that add_traces was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])]) # doctest: +ELLIPSIS
| Figure(...)
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
| ... go.Scatter(x=[1,2,3], y=[2,1,2])],
| ... rows=[1, 2], cols=[1, 1]) # doctest: +ELLIPSIS
| Figure(...)
|
| add_treemap(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Treemap trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The treemap sectors are
| determined by the entries in "labels" or "ids" and in
| "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.treemap.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.treemap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.treemap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.treemap.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.treemap.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.treemap.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.treemap.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.treemap.Tiling` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_violin(self, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Violin trace
|
| In vertical (horizontal) violin plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| violin per distinct x (y) value is drawn If no `x` (`y`) list
| is provided, a single violin is drawn. That violin position is
| then positioned with with `name` or with `x0` (`y0`) if
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| bandwidth
| Sets the bandwidth used to compute the kernel density
| estimate. By default, the bandwidth is determined by
| Silverman's rule of thumb.
| box
| :class:`plotly.graph_objects.violin.Box` instance or
| dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.violin.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual violins or
| sample points or the kernel density estimate or any
| combination of them?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the violins.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.violin.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.violin.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.violin.Marker` instance or
| dict with compatible properties
| meanline
| :class:`plotly.graph_objects.violin.Meanline` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For violin traces, the name
| will also be used for the position coordinate, if `x`
| and `x0` (`y` and `y0` if horizontal) are missing and
| the position axis is categorical. Note that the trace
| name is also used as a default value for attribute
| `scalegroup` (please see its description for details).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the violin(s). If "v" ("h"),
| the distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the violins. If 0, the sample points are places over
| the center of the violins. Positive (negative) values
| correspond to positions to the right (left) for
| vertical violins and above (below) for horizontal
| violins.
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the violins are shown with no sample
| points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set, otherwise defaults to "outliers".
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| scalegroup
| If there are multiple violins that should be sized
| according to to some metric (see `scalemode`), link
| them by providing a non-empty group id here shared by
| every trace in the same group. If a violin's `width` is
| undefined, `scalegroup` will default to the trace's
| name. In this case, violins with the same names will be
| linked together
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same
| (max) width "count" means the violins are scaled by the
| number of sample points making up each violin.
| selected
| :class:`plotly.graph_objects.violin.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| side
| Determines on which side of the position value the
| density function making up one half of a violin is
| plotted. Useful when comparing two violin traces under
| "overlay" mode, where one trace has `side` set to
| "positive" and the other to "negative".
| span
| Sets the span in data space for which the density
| function will be computed. Has an effect only when
| `spanmode` is set to "manual".
| spanmode
| Sets the method by which the span in data space where
| the density function will be computed. "soft" means the
| span goes from the sample's minimum value minus two
| bandwidths to the sample's maximum value plus two
| bandwidths. "hard" means the span goes from the
| sample's minimum to its maximum value. For custom span
| settings, use mode "manual" and fill in the `span`
| attribute.
| stream
| :class:`plotly.graph_objects.violin.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.violin.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the width of the violin in data coordinates. If 0
| (default value) the width is automatically selected
| based on the positions of other violin traces in the
| same subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_vline(self, x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a vertical line to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x: float or int
| A number representing the x coordinate of the vertical line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_volume(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Volume trace
|
| Draws volume trace between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.volume.Caps` instance or
| dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.volume.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.volume.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.volume.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.volume.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.volume.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.volume.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.volume.Slices` instance or
| dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.volume.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.volume.Stream` instance or
| dict with compatible properties
| surface
| :class:`plotly.graph_objects.volume.Surface` instance
| or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_vrect(self, x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a rectangle to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x0: float or int
| A number representing the x coordinate of one side of the rectangle.
| x1: float or int
| A number representing the x coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_waterfall(self, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Waterfall trace
|
| Draws waterfall trace which is useful graph to displays the
| contribution of various elements (either positive or negative)
| in a bar chart. The data visualized by the span of the bars is
| set in `y` if `orientation` is set to "v" (the default) and the
| labels are set in `x`. By setting `orientation` to "h", the
| roles are interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units).
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.waterfall.Connector`
| instance or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.waterfall.Decreasing`
| instance or dict with compatible properties
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.waterfall.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta` and `final`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.waterfall.Increasing`
| instance or dict with compatible properties
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.waterfall.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| measure
| An array containing types of values. By default the
| values are considered as 'relative'. However; it is
| possible to use 'total' to compute the sums. Also
| 'absolute' could be applied to reset the computed total
| or to declare an initial value where needed.
| measuresrc
| Sets the source reference on Chart Studio Cloud for
| `measure`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.waterfall.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple waterfalls, totals are
| computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta`, `final` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| totals
| :class:`plotly.graph_objects.waterfall.Totals` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| for_each_annotation(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all annotations that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single annotation object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotations that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_coloraxis(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all coloraxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single coloraxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_geo(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all geo objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single geo object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_layout_image(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all images that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single image object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| images that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_legend(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all legend objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single legend object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_map(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all map objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single map object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_mapbox(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all mapbox objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single mapbox object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_polar(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all polar objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single polar object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_scene(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all scene objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single scene object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_selection(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all selections that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single selection object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selections that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_shape(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all shapes that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single shape object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shapes that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_smith(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all smith objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single smith object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_ternary(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all ternary objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single ternary object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_trace(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'FigureWidget'
| Apply a function to all traces that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single trace object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_xaxis(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all xaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single xaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'FigureWidget'
| Apply a function to all yaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single yaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| select_annotations(self, selector=None, row=None, col=None, secondary_y=None)
| Select annotations from a particular subplot cell and/or annotations
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the annotations that satisfy
| all of the specified selection criteria
|
| select_coloraxes(self, selector=None, row=None, col=None)
| Select coloraxis subplot objects from a particular subplot cell
| and/or coloraxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the coloraxis
| objects that satisfy all of the specified selection criteria
|
| select_geos(self, selector=None, row=None, col=None)
| Select geo subplot objects from a particular subplot cell
| and/or geo subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the geo
| objects that satisfy all of the specified selection criteria
|
| select_layout_images(self, selector=None, row=None, col=None, secondary_y=None)
| Select images from a particular subplot cell and/or images
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the images that satisfy
| all of the specified selection criteria
|
| select_legends(self, selector=None, row=None, col=None)
| Select legend subplot objects from a particular subplot cell
| and/or legend subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the legend
| objects that satisfy all of the specified selection criteria
|
| select_mapboxes(self, selector=None, row=None, col=None)
| Select mapbox subplot objects from a particular subplot cell
| and/or mapbox subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the mapbox
| objects that satisfy all of the specified selection criteria
|
| select_maps(self, selector=None, row=None, col=None)
| Select map subplot objects from a particular subplot cell
| and/or map subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the map
| objects that satisfy all of the specified selection criteria
|
| select_polars(self, selector=None, row=None, col=None)
| Select polar subplot objects from a particular subplot cell
| and/or polar subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the polar
| objects that satisfy all of the specified selection criteria
|
| select_scenes(self, selector=None, row=None, col=None)
| Select scene subplot objects from a particular subplot cell
| and/or scene subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the scene
| objects that satisfy all of the specified selection criteria
|
| select_selections(self, selector=None, row=None, col=None, secondary_y=None)
| Select selections from a particular subplot cell and/or selections
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the selections that satisfy
| all of the specified selection criteria
|
| select_shapes(self, selector=None, row=None, col=None, secondary_y=None)
| Select shapes from a particular subplot cell and/or shapes
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the shapes that satisfy
| all of the specified selection criteria
|
| select_smiths(self, selector=None, row=None, col=None)
| Select smith subplot objects from a particular subplot cell
| and/or smith subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the smith
| objects that satisfy all of the specified selection criteria
|
| select_ternaries(self, selector=None, row=None, col=None)
| Select ternary subplot objects from a particular subplot cell
| and/or ternary subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the ternary
| objects that satisfy all of the specified selection criteria
|
| select_xaxes(self, selector=None, row=None, col=None)
| Select xaxis subplot objects from a particular subplot cell
| and/or xaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the xaxis
| objects that satisfy all of the specified selection criteria
|
| select_yaxes(self, selector=None, row=None, col=None, secondary_y=None)
| Select yaxis subplot objects from a particular subplot cell
| and/or yaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the yaxis
| objects that satisfy all of the specified selection criteria
|
| set_subplots(self, rows=None, cols=None, **make_subplots_args) -> 'FigureWidget'
| Add subplots to this figure. If the figure already contains subplots,
| then this throws an error. Accepts any keyword arguments that
| plotly.subplots.make_subplots accepts.
|
| update(self, dict1=None, overwrite=False, **kwargs) -> 'FigureWidget'
| Update the properties of the figure with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the figure
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Examples
| --------
| >>> import plotly.graph_objs as go
| >>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
| >>> fig.update(data=[{'y': [4, 5, 6]}]) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'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'}}}) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'data': [],
| 'layout': {'xaxis':
| {'color': 'pink',
| 'range': [0, 1]}}}
|
| Returns
| -------
| BaseFigure
| Updated figure
|
| update_annotations(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all annotations that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all annotations that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected annotation. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_coloraxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all coloraxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| coloraxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| coloraxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_geos(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all geo objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| geo objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| geo object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_layout(self, dict1=None, overwrite=False, **kwargs) -> 'FigureWidget'
| Update the properties of the figure's layout with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| layout with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BaseFigure
| The Figure object that the update_layout method was called on
|
| update_layout_images(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all images that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all images that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected image. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_legends(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all legend objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| legend objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| legend object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_mapboxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all mapbox objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| mapbox objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| mapbox object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_maps(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all map objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| map objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| map object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_polars(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all polar objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| polar objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| polar object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_scenes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all scene objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| scene objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| scene object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_selections(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all selections that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all selections that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected selection. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_shapes(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all shapes that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all shapes that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected shape. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_smiths(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all smith objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| smith objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| smith object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_ternaries(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all ternary objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| ternary objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| ternary object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_traces(self, patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all traces that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all traces that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| **kwargs
| Additional property updates to apply to each selected trace. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_xaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all xaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| xaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| xaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_yaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all yaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| yaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected
| yaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| 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
| The `frames` property is a tuple of the figure's frame objects
|
| Returns
| -------
| tuple[plotly.graph_objs.Frame]
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFigure:
|
| __contains__(self, prop)
|
| __eq__(self, other)
| Return self==value.
|
| __getitem__(self, prop)
|
| __iter__(self)
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __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)
|
| 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(self, duration=500, easing='cubic-in-out')
| 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_animate(duration=2000, easing='elastic-in-out'):
| ... fig.data[0].marker.color = 'green'
| ... fig.data[0].marker.size = 20
|
| batch_update(self)
| 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.
|
| full_figure_for_development(self, warn=True, as_dict=False)
| Compute default values for all attributes not specified in the input figure and
| returns the output as a "full" figure. This function calls Plotly.js via Kaleido
| to populate unspecified attributes. This function is intended for interactive use
| during development to learn more about how Plotly.js computes default values and is
| not generally necessary or recommended for production use.
|
| Parameters
| ----------
| fig:
| Figure object or dict representing a figure
|
| warn: bool
| If False, suppress warnings about not using this in production.
|
| as_dict: bool
| If True, output is a dict with some keys that go.Figure can't parse.
| If False, output is a go.Figure with unparseable keys skipped.
|
| Returns
| -------
| plotly.graph_objects.Figure or dict
| The full figure
|
| get_subplot(self, row, col, secondary_y=False)
| Return an object representing the subplot at the specified row
| and column. May only be used on Figures created using
| plotly.tools.make_subplots
|
| Parameters
| ----------
| row: int
| 1-based index of subplot row
| col: int
| 1-based index of subplot column
| secondary_y: bool
| If True, select the subplot that consists of the x-axis and the
| secondary y-axis at the specified row/col. Only valid if the
| subplot at row/col is an 2D cartesian subplot that was created
| with a secondary y-axis. See the docstring for the specs argument
| to make_subplots for more info on creating a subplot with a
| secondary y-axis.
| Returns
| -------
| subplot
| * None: if subplot is empty
| * plotly.graph_objs.layout.Scene: if subplot type is 'scene'
| * plotly.graph_objs.layout.Polar: if subplot type is 'polar'
| * plotly.graph_objs.layout.Ternary: if subplot type is 'ternary'
| * plotly.graph_objs.layout.Mapbox: if subplot type is 'ternary'
| * SubplotDomain namedtuple with `x` and `y` fields:
| if subplot type is 'domain'.
| - x: length 2 list of the subplot start and stop width
| - y: length 2 list of the subplot start and stop height
| * SubplotXY namedtuple with `xaxis` and `yaxis` fields:
| if subplot type is 'xy'.
| - xaxis: plotly.graph_objs.layout.XAxis instance for subplot
| - yaxis: plotly.graph_objs.layout.YAxis instance for subplot
|
| 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]
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[2, 4, 6]))
| >>> 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
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in figure
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| 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.
|
| select_traces(self, selector=None, row=None, col=None, secondary_y=None)
| Select traces from a particular subplot cell and/or traces
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the traces that satisfy
| all of the specified selection criteria
|
| show(self, *args, **kwargs)
| Show a figure using either the default renderer(s) or the renderer(s)
| specified by the renderer argument
|
| Parameters
| ----------
| renderer: str or None (default None)
| A string containing the names of one or more registered renderers
| (separated by '+' characters) or None. If None, then the default
| renderers specified in plotly.io.renderers.default are used.
|
| validate: bool (default True)
| True if the figure should be validated before being shown,
| False otherwise.
|
| width: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| height: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| config: dict
| A dict of parameters to configure the figure. The defaults are set
| in plotly.js.
|
| Returns
| -------
| None
|
| 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_html(self, *args, **kwargs)
| Convert a figure to an HTML string representation.
|
| Parameters
| ----------
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| str
| Representation of figure as an HTML div string
|
| to_image(self, *args, **kwargs)
| Convert a figure to a static image bytes string
|
| Parameters
| ----------
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified, will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
|
| Returns
| -------
| bytes
| The image data
|
| to_json(self, *args, **kwargs)
| Convert a figure to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of figure as a JSON string
|
| to_ordered_dict(self, skip_uid=True)
|
| to_plotly_json(self)
| Convert figure to a JSON representation as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| write_html(self, *args, **kwargs)
| Write a figure to an HTML file representation
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file. If `file` is a string to a local file
| path and `full_html` is True, then the plotly.min.js bundle is copied
| into the directory of the resulting HTML file. If a file named
| plotly.min.js already exists in the output directory then this file
| is left unmodified and no copy is performed. HTML files generated
| with this option can be used offline, but they require a copy of
| the plotly.min.js bundle in the same directory. This option is
| useful when many figures will be saved as HTML files in the same
| directory because the plotly.js source code will be included only
| once per output directory, rather than once per output file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
|
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| auto_open: bool (default True)
| If True, open the saved file in a web browser after saving.
| This argument only applies if `full_html` is True.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| None
|
| write_image(self, *args, **kwargs)
| Convert a figure to a static image and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
|
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified and `file` is a string then this will default to the
| file extension. If not specified and `file` is not a string then this
| will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
| Returns
| -------
| None
|
| write_json(self, *args, **kwargs)
| Convert a figure to JSON and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. an open file descriptor)
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| None
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BaseFigure:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| 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
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BaseFigure:
|
| __hash__ = None
|
| ----------------------------------------------------------------------
| 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.
|
| blur(self)
| Blur the widget.
|
| focus(self)
| Focus on the widget.
|
| 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.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.domwidget.DOMWidget:
|
| tabbable
| Is widget tabbable?
|
| tooltip
| A tooltip caption.
|
| ----------------------------------------------------------------------
| Methods inherited from ipywidgets.widgets.widget.Widget:
|
| __copy__(self)
|
| __deepcopy__(self, memo)
|
| __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(self)
| Hold syncing any state until the outermost context manager exits
|
| notify_change(self, change)
| Called when a property has changed.
|
| 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()
|
| handle_control_comm_opened(comm, msg)
| Class method, called when the comm-open message on the
| "jupyter.widget.control" comm channel is received
|
| ----------------------------------------------------------------------
| 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)
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ipywidgets.widgets.widget.Widget:
|
| model_id
| Gets the model id of this widget.
|
| If a Comm doesn't exist yet, a Comm will be created automagically.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.widget.Widget:
|
| comm
|
| keys
| The traits which are synced.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from ipywidgets.widgets.widget.Widget:
|
| widget_types = <ipywidgets.widgets.widget.WidgetRegistry object>
|
| widgets = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.widget.LoggingHasTraits:
|
| log
|
| ----------------------------------------------------------------------
| Methods inherited from traitlets.traitlets.HasTraits:
|
| __getstate__(self) -> 'dict[str, t.Any]'
| Helper for pickle.
|
| __setstate__(self, state: 'dict[str, t.Any]') -> 'None'
|
| has_trait(self, name: 'str') -> 'bool'
| Returns True if the object has a trait with the specified name.
|
| hold_trait_notifications(self) -> 't.Any'
| 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: 't.Callable[..., t.Any]', names: 'Sentinel | str | t.Iterable[Sentinel | str]' = traitlets.All, type: 'Sentinel | str' = 'change') -> 'None'
| 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: 'EventHandler | None' = None, name: 'Sentinel | str | None' = None, remove: 'bool' = False) -> 'None'
| 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: 'str', value: 't.Any') -> 'None'
| Forcibly sets trait attribute, including read-only attributes.
|
| setup_instance(*args: 't.Any', **kwargs: 't.Any') -> 'None'
| This is called **before** self.__init__ is called.
|
| trait_defaults(self, *names: 'str', **metadata: 't.Any') -> 'dict[str, t.Any] | Sentinel'
| Return a trait's default value or a dictionary of them
|
| Notes
| -----
| Dynamically generated default values may
| depend on the current state of the object.
|
| trait_has_value(self, name: 'str') -> 'bool'
| Returns True if the specified trait has a value.
|
| This will return false even if ``getattr`` would return a
| dynamically generated default value. These default values
| will be recognized as existing only after they have been
| generated.
|
| Example
|
| .. code-block:: python
|
| class MyClass(HasTraits):
| i = Int()
|
|
| mc = MyClass()
| assert not mc.trait_has_value("i")
| mc.i # generates a default value
| assert mc.trait_has_value("i")
|
| trait_metadata(self, traitname: 'str', key: 'str', default: 't.Any' = None) -> 't.Any'
| Get metadata values for trait by key.
|
| trait_names(self, **metadata: 't.Any') -> 'list[str]'
| Get a list of all the names of this class' traits.
|
| trait_values(self, **metadata: 't.Any') -> 'dict[str, t.Any]'
| A ``dict`` of trait names and their values.
|
| 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.
|
| Returns
| -------
| A ``dict`` of trait names and their values.
|
| Notes
| -----
| Trait values are retrieved via ``getattr``, any exceptions raised
| by traits or the operations they may trigger will result in the
| absence of a trait value in the result ``dict``.
|
| traits(self, **metadata: 't.Any') -> 'dict[str, TraitType[t.Any, t.Any]]'
| 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: 't.Callable[..., t.Any]', names: 'Sentinel | str | t.Iterable[Sentinel | str]' = traitlets.All, type: 'Sentinel | str' = 'change') -> 'None'
| 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: 'str | t.Any' = traitlets.All) -> 'None'
| 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(name: 'str') -> 'dict[str, EventHandler]'
| 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(**metadata: 't.Any') -> 'dict[str, TraitType[t.Any, t.Any]]'
| 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(**metadata: 't.Any') -> 'list[str]'
| 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(**metadata: 't.Any') -> 'dict[str, TraitType[t.Any, t.Any]]'
| 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(name: 'str | None' = None) -> 'dict[str, EventHandler]'
| 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.
|
| ----------------------------------------------------------------------
| Readonly properties 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__(*args: 't.Any', **kwargs: 't.Any') -> 't.Any'
| Create and return a new object. See help(type) for accurate signature.
class Font(builtins.dict)
| Font(*args, **kwargs)
|
| plotly.graph_objs.Font is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Font
| - plotly.graph_objs.layout.hoverlabel.Font
| - etc.
|
| Method resolution order:
| Font
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Font is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Font
| - plotly.graph_objs.layout.hoverlabel.Font
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Frame(plotly.basedatatypes.BaseFrameHierarchyType)
| Frame(arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)
|
| Method resolution order:
| Frame
| plotly.basedatatypes.BaseFrameHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)
| Construct a new Frame object
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Frame`
| 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
|
| Returns
| -------
| Frame
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| baseframe
| The name of the frame into which this frame's properties are
| merged before applying. This is used to unify properties and
| avoid needing to specify the same values for the same
| properties in multiple frames.
|
| The 'baseframe' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| data
| A list of traces this frame modifies. The format is identical
| to the normal trace definition.
|
| Returns
| -------
| Any
|
| group
| An identifier that specifies the group to which the frame
| belongs, used by animate to select a subset of frames.
|
| The 'group' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| layout
| Layout properties which this frame modifies. The format is
| identical to the normal layout definition.
|
| Returns
| -------
| Any
|
| name
| A label by which to identify the frame
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| traces
| A list of trace indices that identify the respective traces in
| the data attribute
|
| The 'traces' property accepts values of any type
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFrameHierarchyType:
|
| on_change(self, callback, *args)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Frames(builtins.list)
| Frames(*args, **kwargs)
|
| plotly.graph_objs.Frames is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Frame
|
| Method resolution order:
| Frames
| builtins.list
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Frames is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Frame
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.list:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.list:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.list:
|
| __new__(*args, **kwargs) class method of builtins.list
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.list:
|
| __hash__ = None
class Funnel(plotly.basedatatypes.BaseTraceType)
| Funnel(arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Funnel
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Funnel object
|
| Visualize stages in a process using length-encoded bars. This
| trace can be used to show data in either a part-to-whole
| representation wherein each item appears in a single stage, or
| in a "drop-off" representation wherein each item appears in
| each stage it traversed. See also the "funnelarea" trace type
| for a different approach to visualizing funnel data.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Funnel`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.funnel.Connector` instance
| or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnel.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious` and
| `percentTotal`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnel.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnel.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the funnels. With "v" ("h"),
| the value of the each bar spans along the vertical
| (horizontal). By default funnels are tend to be
| oriented horizontally; unless only "y" array is
| presented or orientation is set to "v". Also regarding
| graphs including only 'horizontal' funnels, "autorange"
| on the "y-axis" are set to "reversed".
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnel.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple funnels, percentages &
| totals are computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious`,
| `percentTotal`, `label` and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Funnel
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connector
| The 'connector' property is an instance of Connector
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Connector`
| - A dict of string/value properties that will be passed
| to the Connector constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the fill color.
| line
| :class:`plotly.graph_objects.funnel.connector.L
| ine` instance or dict with compatible
| properties
| visible
| Determines if connector regions and lines are
| drawn.
|
| Returns
| -------
| plotly.graph_objs.funnel.Connector
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total'] joined with '+' characters
| (e.g. 'name+x')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `percentInitial`,
| `percentPrevious` and `percentTotal`. Anything contained in tag
| `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.funnel.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.funnel.marker.Colo
| rBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.funnel.marker.Line
| ` instance or dict with compatible properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.funnel.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the position where the bar is drawn (in position axis
| units). In "group" barmode, traces that set "offset" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'offset' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the funnels. With "v" ("h"), the value
| of the each bar spans along the vertical (horizontal). By
| default funnels are tend to be oriented horizontally; unless
| only "y" array is presented or orientation is set to "v". Also
| regarding graphs including only 'horizontal' funnels,
| "autorange" on the "y-axis" are set to "reversed".
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Outsidetextfont
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.funnel.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the font used for `text`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Textfont
|
| textinfo
| Determines which trace information appear on the graph. In the
| case of having multiple funnels, percentages & totals are
| computed separately (per trace).
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'percent initial', 'percent previous', 'percent total', 'value'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `percentInitial`, `percentPrevious`, `percentTotal`, `label`
| and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar width (in position axis units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Funnelarea(plotly.basedatatypes.BaseTraceType)
| Funnelarea(arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Funnelarea
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Funnelarea object
|
| Visualize stages in a process using area-encoded trapezoids.
| This trace can be used to show data in a part-to-whole
| representation similar to a "pie" trace, wherein each item
| appears in a single stage. See also the "funnel" trace type for
| a different approach to visualizing funnel data.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Funnelarea`
| aspectratio
| Sets the ratio between height and width
| baseratio
| Sets the ratio between bottom length and maximum top
| length.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.funnelarea.Domain`
| instance or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnelarea.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnelarea.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnelarea.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnelarea.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.funnelarea.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Funnelarea
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| aspectratio
| Sets the ratio between height and width
|
| The 'aspectratio' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| baseratio
| Sets the ratio between bottom length and maximum top length.
|
| The 'baseratio' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dlabel
| Sets the label step. See `label0` for more info.
|
| The 'dlabel' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this funnelarea
| trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this funnelarea trace
| .
| x
| Sets the horizontal domain of this funnelarea
| trace (in plot fraction).
| y
| Sets the vertical domain of this funnelarea
| trace (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `label`, `color`,
| `value`, `text` and `percent`. Anything contained in tag
| `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Insidetextfont
|
| label0
| Alternate to `labels`. Builds a numeric set of labels. Use with
| `dlabel` where `label0` is the starting label and `dlabel` the
| step.
|
| The 'label0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| labels
| Sets the sector labels. If `labels` entries are duplicated, we
| sum associated `values` or simply count occurrences if `values`
| is not provided. For other array attributes (including color)
| we use the first non-empty entry among all occurrences of the
| label.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| colors
| Sets the color of each sector. If not
| specified, the default trace color set is used
| to pick the sector colors.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.funnelarea.marker.
| Line` instance or dict with compatible
| properties
| pattern
| Sets the pattern within the marker.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a non-empty
| group id here shared by every trace in the same group.
|
| The 'scalegroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `textinfo`.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `label`,
| `color`, `value`, `text` and `percent`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| font
| Sets the font used for `title`. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| position
| Specifies the location of the `title`. Note
| that the title's position used to be set by the
| now deprecated `titleposition` attribute.
| text
| Sets the title of the chart. If it is empty, no
| title is displayed. Note that before the
| existence of `title.text`, the title's contents
| used to be defined as the `title` attribute
| itself. This behavior has been deprecated.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Title
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Heatmap(plotly.basedatatypes.BaseTraceType)
| Heatmap(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Heatmap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Heatmap object
|
| The data that describes the heatmap value-to-color mapping is
| set in `z`. Data in `z` can either be a 2D list of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a 2D list, say that `z` has N rows and M columns. Then, by
| default, the resulting heatmap will have N partitions along the
| y axis and M partitions along the x axis. In other words, the
| i-th row/ j-th column cell in `z` is mapped to the i-th
| partition of the y axis (starting from the bottom of the plot)
| and the j-th partition of the x-axis (starting from the left of
| the plot). This behavior can be flipped by using `transpose`.
| Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1)
| elements. If M (N), then the coordinates correspond to the
| center of the heatmap cells and the cells have equal width. If
| M+1 (N+1), then the coordinates correspond to the edges of the
| heatmap cells. In the case where `z` is a 1D list, the x and y
| coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Heatmap`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmap.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array and `zsmooth`
| is not false; otherwise it is defaulted to false.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmap.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmap.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Heatmap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.heatmap
| .colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.heatmap.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of heatmap.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.heatmap.colorbar.T
| itle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| heatmap.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| heatmap.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.heatmap.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data are filled in. It is defaulted to true if `z`
| is a one dimensional array and `zsmooth` is not false;
| otherwise it is defaulted to false.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Hoverlabel
|
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data have hover labels associated with them.
|
| The 'hoverongaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Textfont
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `x`, `y`,
| `z` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xgap
| Sets the horizontal gap (in pixels) between bricks.
|
| The 'xgap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xtype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'xtype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| ygap
| Sets the vertical gap (in pixels) between bricks.
|
| The 'ygap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ytype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'ytype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', 'best', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Heatmapgl(plotly.basedatatypes.BaseTraceType)
| Heatmapgl(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Heatmapgl
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Heatmapgl object
|
| "heatmapgl" trace is deprecated! Please consider switching to
| the "heatmap" or "image" trace types. Alternatively you could
| contribute/sponsor rewriting this trace type based on cartesian
| features and using regl framework. WebGL version of the heatmap
| trace type.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Heatmapgl`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmapgl.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmapgl.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmapgl.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Heatmapgl
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.heatmap
| gl.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.heatmapgl.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of heatmapgl.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.heatmapgl.colorbar
| .Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| heatmapgl.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| heatmapgl.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xtype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'xtype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ytype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'ytype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram(plotly.basedatatypes.BaseTraceType)
| Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Histogram
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Histogram object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Histogram`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| bingroup
| Set a group of histogram traces which will have
| compatible bin settings. Note that traces on the same
| subplot and with the same "orientation" under `barmode`
| "stack", "relative" and "group" are forced into the
| same bingroup, Using `bingroup`, traces under `barmode`
| "overlay" and on different axes (of the same axis type)
| can have compatible bin settings. Note that histogram
| and histogram2d* trace can share the same `bingroup`
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| cumulative
| :class:`plotly.graph_objects.histogram.Cumulative`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.histogram.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.histogram.ErrorY` instance
| or dict with compatible properties
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `binNumber` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.histogram.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.histogram.Stream` instance
| or dict with compatible properties
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the text font.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label` and `value`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.histogram.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbins
| :class:`plotly.graph_objects.histogram.XBins` instance
| or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybins
| :class:`plotly.graph_objects.histogram.YBins` instance
| or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Histogram
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobinx` is not needed. However, we accept
| `autobinx: true` or `false` and will update `xbins` accordingly
| before deleting `autobinx` from the trace.
|
| The 'autobinx' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobiny` is not needed. However, we accept
| `autobiny: true` or `false` and will update `ybins` accordingly
| before deleting `autobiny` from the trace.
|
| The 'autobiny' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| bingroup
| Set a group of histogram traces which will have compatible bin
| settings. Note that traces on the same subplot and with the
| same "orientation" under `barmode` "stack", "relative" and
| "group" are forced into the same bingroup, Using `bingroup`,
| traces under `barmode` "overlay" and on different axes (of the
| same axis type) can have compatible bin settings. Note that
| histogram and histogram2d* trace can share the same `bingroup`
|
| The 'bingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| cumulative
| The 'cumulative' property is an instance of Cumulative
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Cumulative`
| - A dict of string/value properties that will be passed
| to the Cumulative constructor
|
| Supported dict properties:
|
| currentbin
| Only applies if cumulative is enabled. Sets
| whether the current bin is included, excluded,
| or has half of its value included in the
| current cumulative value. "include" is the
| default for compatibility with various other
| tools, however it introduces a half-bin bias to
| the results. "exclude" makes the opposite half-
| bin bias, and "half" removes it.
| direction
| Only applies if cumulative is enabled. If
| "increasing" (default) we sum all prior bins,
| so the result increases from left to right. If
| "decreasing" we sum later bins so the result
| decreases from left to right.
| enabled
| If true, display the cumulative distribution by
| summing the binned values. Use the `direction`
| and `centralbin` attributes to tune the
| accumulation method. Note: in this mode, the
| "density" `histnorm` settings behave the same
| as their equivalents without "density": "" and
| "density" both rise to the number of data
| points, and "probability" and *probability
| density* both rise to the number of sample
| points.
|
| Returns
| -------
| plotly.graph_objs.histogram.Cumulative
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.histogram.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.histogram.ErrorY
|
| histfunc
| Specifies the binning function used for this histogram trace.
| If "count", the histogram values are computed by counting the
| number of values lying inside each bin. If "sum", "avg", "min",
| "max", the histogram values are computed using the sum, the
| average, the minimum or the maximum of the values lying inside
| each bin respectively.
|
| The 'histfunc' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['count', 'sum', 'avg', 'min', 'max']
|
| Returns
| -------
| Any
|
| histnorm
| Specifies the type of normalization used for this histogram
| trace. If "", the span of each bar corresponds to the number of
| occurrences (i.e. the number of data points lying inside the
| bins). If "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences with
| respect to the total number of sample points (here, the sum of
| all bin HEIGHTS equals 100% / 1). If "density", the span of
| each bar corresponds to the number of occurrences in a bin
| divided by the size of the bin interval (here, the sum of all
| bin AREAS equals the total number of sample points). If
| *probability density*, the area of each bar corresponds to the
| probability that an event will fall into the corresponding bin
| (here, the sum of all bin AREAS equals 1).
|
| The 'histnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'percent', 'probability', 'density', 'probability
| density']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.histogram.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `binNumber` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.histogram.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.histogram.marker.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| cornerradius
| Sets the rounding of corners. May be an integer
| number of pixels, or a percentage of bar width
| (as a string ending in %). Defaults to
| `layout.barcornerradius`. In stack or relative
| barmode, the first trace to set cornerradius is
| used for the whole stack.
| line
| :class:`plotly.graph_objects.histogram.marker.L
| ine` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.histogram.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| nbinsx
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `xbins.size` is provided.
|
| The 'nbinsx' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| nbinsy
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `ybins.size` is provided.
|
| The 'nbinsy' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the bars. With "v" ("h"), the value of
| the each bar spans along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram.Outsidetextfont
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.histogram.selected
| .Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.histogram.selected
| .Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.histogram.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.histogram.Stream
|
| text
| Sets hover text elements associated with each bar. If a single
| string, the same string appears over all bars. If an array of
| string, the items are mapped in order to the this trace's
| coordinates.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram.Textfont
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `label`
| and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.histogram.unselect
| ed.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.histogram.unselect
| ed.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.histogram.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the sample data to be binned on the x axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbins
| The 'xbins' property is an instance of XBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.XBins`
| - A dict of string/value properties that will be passed
| to the XBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the x axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each x axis bin. Default
| behavior: If `nbinsx` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsx` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1). If multiple non-overlaying histograms
| share a subplot, the first explicit `size` is
| used and all others discarded. If no `size` is
| provided,the sample data from all traces is
| combined to determine `size` as described
| above.
| start
| Sets the starting value for the x axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5. If multiple non-
| overlaying histograms share a subplot, the
| first explicit `start` is used exactly and all
| others are shifted down (if necessary) to
| differ from that one by an integer number of
| bins.
|
| Returns
| -------
| plotly.graph_objs.histogram.XBins
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the sample data to be binned on the y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybins
| The 'ybins' property is an instance of YBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.YBins`
| - A dict of string/value properties that will be passed
| to the YBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the y axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each y axis bin. Default
| behavior: If `nbinsy` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsy` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1). If multiple non-overlaying histograms
| share a subplot, the first explicit `size` is
| used and all others discarded. If no `size` is
| provided,the sample data from all traces is
| combined to determine `size` as described
| above.
| start
| Sets the starting value for the y axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5. If multiple non-
| overlaying histograms share a subplot, the
| first explicit `start` is used exactly and all
| others are shifted down (if necessary) to
| differ from that one by an integer number of
| bins.
|
| Returns
| -------
| plotly.graph_objs.histogram.YBins
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram2d(plotly.basedatatypes.BaseTraceType)
| Histogram2d(arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Histogram2d
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Histogram2d object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Histogram2d`
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2d.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2d.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram2d.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2d.Stream`
| instance or dict with compatible properties
| textfont
| Sets the text font.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z`
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2d.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2d.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Histogram2d
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobinx` is not needed. However, we accept
| `autobinx: true` or `false` and will update `xbins` accordingly
| before deleting `autobinx` from the trace.
|
| The 'autobinx' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobiny` is not needed. However, we accept
| `autobiny: true` or `false` and will update `ybins` accordingly
| before deleting `autobiny` from the trace.
|
| The 'autobiny' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For example,
| setting a `bingroup` of 1 on two histogram2d traces will make
| them their x-bins and y-bins match separately.
|
| The 'bingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.histogr
| am2d.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.histogram2d.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of
| histogram2d.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.histogram2d.colorb
| ar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| histogram2d.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| histogram2d.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| histfunc
| Specifies the binning function used for this histogram trace.
| If "count", the histogram values are computed by counting the
| number of values lying inside each bin. If "sum", "avg", "min",
| "max", the histogram values are computed using the sum, the
| average, the minimum or the maximum of the values lying inside
| each bin respectively.
|
| The 'histfunc' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['count', 'sum', 'avg', 'min', 'max']
|
| Returns
| -------
| Any
|
| histnorm
| Specifies the type of normalization used for this histogram
| trace. If "", the span of each bar corresponds to the number of
| occurrences (i.e. the number of data points lying inside the
| bins). If "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences with
| respect to the total number of sample points (here, the sum of
| all bin HEIGHTS equals 100% / 1). If "density", the span of
| each bar corresponds to the number of occurrences in a bin
| divided by the size of the bin interval (here, the sum of all
| bin AREAS equals the total number of sample points). If
| *probability density*, the area of each bar corresponds to the
| probability that an event will fall into the corresponding bin
| (here, the sum of all bin AREAS equals 1).
|
| The 'histnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'percent', 'probability', 'density', 'probability
| density']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `z` Anything contained
| in tag `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| color
| Sets the aggregation data.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| nbinsx
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `xbins.size` is provided.
|
| The 'nbinsx' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| nbinsy
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `ybins.size` is provided.
|
| The 'nbinsy' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Stream
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Textfont
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variable `z`
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the sample data to be binned on the x axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbingroup
| Set a group of histogram traces which will have compatible
| x-bin settings. Using `xbingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible x-bin settings. Note that the same `xbingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'xbingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xbins
| The 'xbins' property is an instance of XBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.XBins`
| - A dict of string/value properties that will be passed
| to the XBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the x axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each x axis bin. Default
| behavior: If `nbinsx` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsx` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the x axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.XBins
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xgap
| Sets the horizontal gap (in pixels) between bricks.
|
| The 'xgap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the sample data to be binned on the y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybingroup
| Set a group of histogram traces which will have compatible
| y-bin settings. Using `ybingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible y-bin settings. Note that the same `ybingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'ybingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ybins
| The 'ybins' property is an instance of YBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.YBins`
| - A dict of string/value properties that will be passed
| to the YBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the y axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each y axis bin. Default
| behavior: If `nbinsy` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsy` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the y axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.YBins
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| ygap
| Sets the vertical gap (in pixels) between bricks.
|
| The 'ygap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the aggregation data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', 'best', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram2dContour(plotly.basedatatypes.BaseTraceType)
| Histogram2dContour(arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Histogram2dContour
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Histogram2dContour object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Histogram2dContour`
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2dcontour.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.histogram2dcontour.Contour
| s` instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2dcontour.Hoverla
| bel` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2dcontour.Legendg
| rouptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.histogram2dcontour.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.histogram2dcontour.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2dcontour.Stream`
| instance or dict with compatible properties
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2dcontour.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2dcontour.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Histogram2dContour
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobinx` is not needed. However, we accept
| `autobinx: true` or `false` and will update `xbins` accordingly
| before deleting `autobinx` from the trace.
|
| The 'autobinx' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobiny` is not needed. However, we accept
| `autobiny: true` or `false` and will update `ybins` accordingly
| before deleting `autobiny` from the trace.
|
| The 'autobiny' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocontour
| Determines whether or not the contour level attributes are
| picked by an algorithm. If True, the number of contour levels
| can be set in `ncontours`. If False, set the contour level
| attributes in `contours`.
|
| The 'autocontour' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For example,
| setting a `bingroup` of 1 on two histogram2d traces will make
| them their x-bins and y-bins match separately.
|
| The 'bingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.histogr
| am2dcontour.colorbar.Tickformatstop` instances
| or dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.histogram2dcontour.colorbar.tickformatstopdef
| aults), sets the default property values to use
| for elements of
| histogram2dcontour.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.histogram2dcontour
| .colorbar.Title` instance or dict with
| compatible properties
| titlefont
| Deprecated: Please use
| histogram2dcontour.colorbar.title.font instead.
| Sets this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| histogram2dcontour.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| coloring
| Determines the coloring method showing the
| contour values. If "fill", coloring is done
| evenly between each contour level If "heatmap",
| a heatmap gradient coloring is applied between
| each contour level. If "lines", coloring is
| done on the contour lines. If "none", no
| coloring is applied on this trace.
| end
| Sets the end contour level value. Must be more
| than `contours.start`
| labelfont
| Sets the font used for labeling the contour
| levels. The default color comes from the lines,
| if shown. The default family and size come from
| `layout.font`.
| labelformat
| Sets the contour label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| operation
| Sets the constraint operation. "=" keeps
| regions equal to `value` "<" and "<=" keep
| regions less than `value` ">" and ">=" keep
| regions greater than `value` "[]", "()", "[)",
| and "(]" keep regions inside `value[0]` to
| `value[1]` "][", ")(", "](", ")[" keep regions
| outside `value[0]` to value[1]` Open vs. closed
| intervals make no difference to constraint
| display, but all versions are allowed for
| consistency with filter transforms.
| showlabels
| Determines whether to label the contour lines
| with their values.
| showlines
| Determines whether or not the contour lines are
| drawn. Has an effect only if
| `contours.coloring` is set to "fill".
| size
| Sets the step between each contour level. Must
| be positive.
| start
| Sets the starting contour level value. Must be
| less than `contours.end`
| type
| If `levels`, the data is represented as a
| contour plot with multiple levels displayed. If
| `constraint`, the data is represented as
| constraints with the invalid region shaded as
| specified by the `operation` and `value`
| parameters.
| value
| Sets the value or values of the constraint
| boundary. When `operation` is set to one of the
| comparison values (=,<,>=,>,<=) "value" is
| expected to be a number. When `operation` is
| set to one of the interval values
| ([],(),[),(],][,)(,](,)[) "value" is expected
| to be an array of two numbers where the first
| is the lower bound and the second is the upper
| bound.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| histfunc
| Specifies the binning function used for this histogram trace.
| If "count", the histogram values are computed by counting the
| number of values lying inside each bin. If "sum", "avg", "min",
| "max", the histogram values are computed using the sum, the
| average, the minimum or the maximum of the values lying inside
| each bin respectively.
|
| The 'histfunc' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['count', 'sum', 'avg', 'min', 'max']
|
| Returns
| -------
| Any
|
| histnorm
| Specifies the type of normalization used for this histogram
| trace. If "", the span of each bar corresponds to the number of
| occurrences (i.e. the number of data points lying inside the
| bins). If "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences with
| respect to the total number of sample points (here, the sum of
| all bin HEIGHTS equals 100% / 1). If "density", the span of
| each bar corresponds to the number of occurrences in a bin
| divided by the size of the bin interval (here, the sum of all
| bin AREAS equals the total number of sample points). If
| *probability density*, the area of each bar corresponds to the
| probability that an event will fall into the corresponding bin
| (here, the sum of all bin AREAS equals 1).
|
| The 'histnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'percent', 'probability', 'density', 'probability
| density']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `z` Anything contained
| in tag `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour level. Has no
| effect if `contours.coloring` is set to
| "lines".
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| smoothing
| Sets the amount of smoothing for the contour
| lines, where 0 corresponds to no smoothing.
| width
| Sets the contour line width in (in px)
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| color
| Sets the aggregation data.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| nbinsx
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `xbins.size` is provided.
|
| The 'nbinsx' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| nbinsy
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `ybins.size` is provided.
|
| The 'nbinsy' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| ncontours
| Sets the maximum number of contour levels. The actual number of
| contours will be chosen automatically to be less than or equal
| to the value of `ncontours`. Has an effect only if
| `autocontour` is True or if `contours.size` is missing.
|
| The 'ncontours' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [1, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Stream
|
| textfont
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Textfont
|
| texttemplate
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Template string used for rendering the information
| text that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable}, for
| example "y: %{y}". Numbers are formatted using d3-format's
| syntax %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `x`, `y`,
| `z` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the sample data to be binned on the x axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbingroup
| Set a group of histogram traces which will have compatible
| x-bin settings. Using `xbingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible x-bin settings. Note that the same `xbingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'xbingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xbins
| The 'xbins' property is an instance of XBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.XBins`
| - A dict of string/value properties that will be passed
| to the XBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the x axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each x axis bin. Default
| behavior: If `nbinsx` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsx` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the x axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.XBins
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the sample data to be binned on the y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybingroup
| Set a group of histogram traces which will have compatible
| y-bin settings. Using `ybingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible y-bin settings. Note that the same `ybingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'ybingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ybins
| The 'ybins' property is an instance of YBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.YBins`
| - A dict of string/value properties that will be passed
| to the YBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the y axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each y axis bin. Default
| behavior: If `nbinsy` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsy` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the y axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.YBins
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the aggregation data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram2dcontour(builtins.dict)
| Histogram2dcontour(*args, **kwargs)
|
| plotly.graph_objs.Histogram2dcontour is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Histogram2dContour
|
| Method resolution order:
| Histogram2dcontour
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Histogram2dcontour is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Histogram2dContour
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Icicle(plotly.basedatatypes.BaseTraceType)
| Icicle(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Icicle
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Icicle object
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The icicle sectors are determined
| by the entries in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Icicle`
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.icicle.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.icicle.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.icicle.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.icicle.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.icicle.Marker` instance or
| dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.icicle.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.icicle.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.icicle.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.icicle.Tiling` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Icicle
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| branchvalues
| Determines how the items in `values` are summed. When set to
| "total", items in `values` are taken to be value of all its
| descendants. When set to "remainder", items in `values`
| corresponding to the root and the branches sectors are taken to
| be the extra part not part of the sum of the values at their
| leaves.
|
| The 'branchvalues' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['remainder', 'total']
|
| Returns
| -------
| Any
|
| count
| Determines default for `values` when it is not provided, by
| inferring a 1 for each of the "leaves" and/or "branches",
| otherwise 0.
|
| The 'count' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['branches', 'leaves'] joined with '+' characters
| (e.g. 'branches+leaves')
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this icicle trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this icicle trace .
| x
| Sets the horizontal domain of this icicle trace
| (in plot fraction).
| y
| Sets the vertical domain of this icicle trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.icicle.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `currentPath`, `root`,
| `entry`, `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Insidetextfont
|
| labels
| Sets the labels of each of the sectors.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| leaf
| The 'leaf' property is an instance of Leaf
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Leaf`
| - A dict of string/value properties that will be passed
| to the Leaf constructor
|
| Supported dict properties:
|
| opacity
| Sets the opacity of the leaves. With colorscale
| it is defaulted to 1; otherwise it is defaulted
| to 0.7
|
| Returns
| -------
| plotly.graph_objs.icicle.Leaf
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.icicle.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| level
| Sets the level from which this trace hierarchy is rendered. Set
| `level` to `''` to start from the root node in the hierarchy.
| Must be an "id" if `ids` is filled in, otherwise plotly
| attempts to find a matching item in `labels`.
|
| The 'level' property accepts values of any type
|
| Returns
| -------
| Any
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if colors is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| colors) or the bounds set in `marker.cmin` and
| `marker.cmax` Has an effect only if colors is
| set to a numerical array. Defaults to `false`
| when `marker.cmin` and `marker.cmax` are set by
| the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmin` must be set as
| well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if colors is set to a numerical array.
| Value should have the same units as colors. Has
| no effect when `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmax` must be set as
| well.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.icicle.marker.Colo
| rBar` instance or dict with compatible
| properties
| colors
| Sets the color of each sector of this trace. If
| not specified, the default trace color set is
| used to pick the sector colors.
| colorscale
| Sets the colorscale. Has an effect only if
| colors is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.icicle.marker.Line
| ` instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if colors is set to a numerical
| array. If true, `marker.cmin` will correspond
| to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| colors is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.icicle.Marker
|
| maxdepth
| Sets the number of rendered sectors from any given `level`. Set
| `maxdepth` to "-1" to render all the levels in the hierarchy.
|
| The 'maxdepth' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
| This option refers to the root of the hierarchy presented on
| top left corner of a treemap graph. Please note that if a
| hierarchy has multiple root nodes, this option won't have any
| effect and `insidetextfont` would be used.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Outsidetextfont
|
| parents
| Sets the parent sectors for each of the sectors. Empty string
| items '' are understood to reference the root node in the
| hierarchy. If `ids` is filled, `parents` items are understood
| to be "ids" themselves. When `ids` is not set, plotly attempts
| to find matching items in `labels`, but beware they must be
| unique.
|
| The 'parents' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| parentssrc
| Sets the source reference on Chart Studio Cloud for `parents`.
|
| The 'parentssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| pathbar
| The 'pathbar' property is an instance of Pathbar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Pathbar`
| - A dict of string/value properties that will be passed
| to the Pathbar constructor
|
| Supported dict properties:
|
| edgeshape
| Determines which shape is used for edges
| between `barpath` labels.
| side
| Determines on which side of the the treemap the
| `pathbar` should be presented.
| textfont
| Sets the font used inside `pathbar`.
| thickness
| Sets the thickness of `pathbar` (in px). If not
| specified the `pathbar.textfont.size` is used
| with 3 pixles extra padding on each side.
| visible
| Determines if the path bar is drawn i.e.
| outside the trace `domain` and with one pixel
| gap.
|
| Returns
| -------
| plotly.graph_objs.icicle.Pathbar
|
| root
| The 'root' property is an instance of Root
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Root`
| - A dict of string/value properties that will be passed
| to the Root constructor
|
| Supported dict properties:
|
| color
| sets the color of the root node for a
| sunburst/treemap/icicle trace. this has no
| effect when a colorscale is used to set the
| markers.
|
| Returns
| -------
| plotly.graph_objs.icicle.Root
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.icicle.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Sets the positions of the `text` elements.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
| `percentParent`, `label` and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| tiling
| The 'tiling' property is an instance of Tiling
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Tiling`
| - A dict of string/value properties that will be passed
| to the Tiling constructor
|
| Supported dict properties:
|
| flip
| Determines if the positions obtained from
| solver are flipped on each axis.
| orientation
| When set in conjunction with `tiling.flip`,
| determines on which side the root nodes are
| drawn in the chart. If `tiling.orientation` is
| "v" and `tiling.flip` is "", the root nodes
| appear at the top. If `tiling.orientation` is
| "v" and `tiling.flip` is "y", the root nodes
| appear at the bottom. If `tiling.orientation`
| is "h" and `tiling.flip` is "", the root nodes
| appear at the left. If `tiling.orientation` is
| "h" and `tiling.flip` is "x", the root nodes
| appear at the right.
| pad
| Sets the inner padding (in px).
|
| Returns
| -------
| plotly.graph_objs.icicle.Tiling
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values associated with each of the sectors. Use with
| `branchvalues` to determine how the values are summed.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Image(plotly.basedatatypes.BaseTraceType)
| Image(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Image
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Image object
|
| Display an image, i.e. data on a 2D regular raster. By default,
| when an image is displayed in a subplot, its y axis will be
| reversed (ie. `autorange: 'reversed'`), constrained to the
| domain (ie. `constrain: 'domain'`) and it will have the same
| scale as its x axis (ie. `scaleanchor: 'x,`) in order for
| pixels to be rendered as squares.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Image`
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified,
| this attribute will be set to `rgba256` otherwise it
| defaults to `rgb`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Set the pixel's horizontal size.
| dy
| Set the pixel's vertical size
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.image.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `z`, `color` and `colormodel`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.image.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| source
| Specifies the data URI of the image to be visualized.
| The URI consists of "data:image/[<media
| subtype>][;base64],<data>"
| stream
| :class:`plotly.graph_objects.image.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Set the image's x position. The left edge of the image
| (or the right edge if the x axis is reversed or dx is
| negative) will be found at xmin=x0-dx/2
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| y0
| Set the image's y position. The top edge of the image
| (or the bottom edge if the y axis is NOT reversed or if
| dy is negative) will be found at ymin=y0-dy/2. By
| default when an image trace is included, the y axis
| will be reversed so that the image is right-side-up,
| but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis
| range.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| A 2-dimensional array in which each element is an array
| of 3 or 4 numbers representing a color.
| zmax
| Array defining the higher bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [255,
| 255, 255]. For the `rgba` colormodel, it is [255, 255,
| 255, 1]. For the `rgba256` colormodel, it is [255, 255,
| 255, 255]. For the `hsl` colormodel, it is [360, 100,
| 100]. For the `hsla` colormodel, it is [360, 100, 100,
| 1].
| zmin
| Array defining the lower bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [0, 0,
| 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For
| the `rgba256` colormodel, it is [0, 0, 0, 0]. For the
| `hsl` colormodel, it is [0, 0, 0]. For the `hsla`
| colormodel, it is [0, 0, 0, 0].
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data.
| This only applies for image traces that use the
| `source` attribute.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Image
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified, this
| attribute will be set to `rgba256` otherwise it defaults to
| `rgb`.
|
| The 'colormodel' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Set the pixel's horizontal size.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Set the pixel's vertical size
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'color', 'name', 'text'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.image.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.image.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `z`, `color` and
| `colormodel`. Anything contained in tag `<extra>` is displayed
| in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.image.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.image.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| source
| Specifies the data URI of the image to be visualized. The URI
| consists of "data:image/[<media subtype>][;base64],<data>"
|
| The 'source' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.image.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.image.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x0
| Set the image's x position. The left edge of the image (or the
| right edge if the x axis is reversed or dx is negative) will be
| found at xmin=x0-dx/2
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| y0
| Set the image's y position. The top edge of the image (or the
| bottom edge if the y axis is NOT reversed or if dy is negative)
| will be found at ymin=y0-dy/2. By default when an image trace
| is included, the y axis will be reversed so that the image is
| right-side-up, but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis range.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| z
| A 2-dimensional array in which each element is an array of 3 or
| 4 numbers representing a color.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zmax
| Array defining the higher bound for each color component. Note
| that the default value will depend on the colormodel. For the
| `rgb` colormodel, it is [255, 255, 255]. For the `rgba`
| colormodel, it is [255, 255, 255, 1]. For the `rgba256`
| colormodel, it is [255, 255, 255, 255]. For the `hsl`
| colormodel, it is [360, 100, 100]. For the `hsla` colormodel,
| it is [360, 100, 100, 1].
|
| The 'zmax' property is an info array that may be specified as:
|
| * a list or tuple of 4 elements where:
| (0) The 'zmax[0]' property is a number and may be specified as:
| - An int or float
| (1) The 'zmax[1]' property is a number and may be specified as:
| - An int or float
| (2) The 'zmax[2]' property is a number and may be specified as:
| - An int or float
| (3) The 'zmax[3]' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| list
|
| zmin
| Array defining the lower bound for each color component. Note
| that the default value will depend on the colormodel. For the
| `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel,
| it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0,
| 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the
| `hsla` colormodel, it is [0, 0, 0, 0].
|
| The 'zmin' property is an info array that may be specified as:
|
| * a list or tuple of 4 elements where:
| (0) The 'zmin[0]' property is a number and may be specified as:
| - An int or float
| (1) The 'zmin[1]' property is a number and may be specified as:
| - An int or float
| (2) The 'zmin[2]' property is a number and may be specified as:
| - An int or float
| (3) The 'zmin[3]' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| list
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data. This only
| applies for image traces that use the `source` attribute.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Indicator(plotly.basedatatypes.BaseTraceType)
| Indicator(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)
|
| Method resolution order:
| Indicator
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)
| Construct a new Indicator object
|
| An indicator is used to visualize a single `value` along with
| some contextual information such as `steps` or a `threshold`,
| using a combination of three visual elements: a number, a
| delta, and/or a gauge. Deltas are taken with respect to a
| `reference`. Gauges can be either angular or bullet (aka
| linear) gauges.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Indicator`
| align
| Sets the horizontal alignment of the `text` within the
| box. Note that this attribute has no effect if an
| angular gauge is displayed: in this case, it is always
| centered
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delta
| :class:`plotly.graph_objects.indicator.Delta` instance
| or dict with compatible properties
| domain
| :class:`plotly.graph_objects.indicator.Domain` instance
| or dict with compatible properties
| gauge
| The gauge of the Indicator plot.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.indicator.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines how the value is displayed on the graph.
| `number` displays the value numerically in text.
| `delta` displays the difference to a reference value in
| text. Finally, `gauge` displays the value graphically
| on an axis.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| number
| :class:`plotly.graph_objects.indicator.Number` instance
| or dict with compatible properties
| stream
| :class:`plotly.graph_objects.indicator.Stream` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.indicator.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the number to be displayed.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Indicator
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| align
| Sets the horizontal alignment of the `text` within the box.
| Note that this attribute has no effect if an angular gauge is
| displayed: in this case, it is always centered
|
| The 'align' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['left', 'center', 'right']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| delta
| The 'delta' property is an instance of Delta
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Delta`
| - A dict of string/value properties that will be passed
| to the Delta constructor
|
| Supported dict properties:
|
| decreasing
| :class:`plotly.graph_objects.indicator.delta.De
| creasing` instance or dict with compatible
| properties
| font
| Set the font used to display the delta
| increasing
| :class:`plotly.graph_objects.indicator.delta.In
| creasing` instance or dict with compatible
| properties
| position
| Sets the position of delta with respect to the
| number.
| prefix
| Sets a prefix appearing before the delta.
| reference
| Sets the reference value to compute the delta.
| By default, it is set to the current value.
| relative
| Show relative change
| suffix
| Sets a suffix appearing next to the delta.
| valueformat
| Sets the value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
|
| Returns
| -------
| plotly.graph_objs.indicator.Delta
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this indicator
| trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this indicator trace .
| x
| Sets the horizontal domain of this indicator
| trace (in plot fraction).
| y
| Sets the vertical domain of this indicator
| trace (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.indicator.Domain
|
| gauge
| The gauge of the Indicator plot.
|
| The 'gauge' property is an instance of Gauge
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Gauge`
| - A dict of string/value properties that will be passed
| to the Gauge constructor
|
| Supported dict properties:
|
| axis
| :class:`plotly.graph_objects.indicator.gauge.Ax
| is` instance or dict with compatible properties
| bar
| Set the appearance of the gauge's value
| bgcolor
| Sets the gauge background color.
| bordercolor
| Sets the color of the border enclosing the
| gauge.
| borderwidth
| Sets the width (in px) of the border enclosing
| the gauge.
| shape
| Set the shape of the gauge
| steps
| A tuple of :class:`plotly.graph_objects.indicat
| or.gauge.Step` instances or dicts with
| compatible properties
| stepdefaults
| When used in a template (as layout.template.dat
| a.indicator.gauge.stepdefaults), sets the
| default property values to use for elements of
| indicator.gauge.steps
| threshold
| :class:`plotly.graph_objects.indicator.gauge.Th
| reshold` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.indicator.Gauge
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.indicator.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines how the value is displayed on the graph. `number`
| displays the value numerically in text. `delta` displays the
| difference to a reference value in text. Finally, `gauge`
| displays the value graphically on an axis.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['number', 'delta', 'gauge'] joined with '+' characters
| (e.g. 'number+delta')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| number
| The 'number' property is an instance of Number
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Number`
| - A dict of string/value properties that will be passed
| to the Number constructor
|
| Supported dict properties:
|
| font
| Set the font used to display main number
| prefix
| Sets a prefix appearing before the number.
| suffix
| Sets a suffix appearing next to the number.
| valueformat
| Sets the value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
|
| Returns
| -------
| plotly.graph_objs.indicator.Number
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.indicator.Stream
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the title. It
| defaults to `center` except for bullet charts
| for which it defaults to right.
| font
| Set the font used to display the title
| text
| Sets the title of this indicator.
|
| Returns
| -------
| plotly.graph_objs.indicator.Title
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| value
| Sets the number to be displayed.
|
| The 'value' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Isosurface(plotly.basedatatypes.BaseTraceType)
| Isosurface(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Isosurface
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Isosurface object
|
| Draws isosurfaces between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Isosurface`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.isosurface.Caps` instance
| or dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.isosurface.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.isosurface.Contour`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.isosurface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.isosurface.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.isosurface.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.isosurface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.isosurface.Slices`
| instance or dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.isosurface.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.isosurface.Stream`
| instance or dict with compatible properties
| surface
| :class:`plotly.graph_objects.isosurface.Surface`
| instance or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Isosurface
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| caps
| The 'caps' property is an instance of Caps
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Caps`
| - A dict of string/value properties that will be passed
| to the Caps constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.isosurface.caps.X`
| instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.isosurface.caps.Y`
| instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.isosurface.caps.Z`
| instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.isosurface.Caps
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here `value`) or the bounds set in
| `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as `value` and if set, `cmin` must be set as well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as `value`. Has no effect when `cauto` is `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as `value` and if set, `cmax` must be set as well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.isosurf
| ace.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.isosurface.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of isosurface.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.isosurface.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| isosurface.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| isosurface.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.isosurface.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contour
| The 'contour' property is an instance of Contour
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Contour`
| - A dict of string/value properties that will be passed
| to the Contour constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour lines.
| show
| Sets whether or not dynamic contours are shown
| on hover
| width
| Sets the width of the contour lines.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Contour
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| flatshading
| Determines whether or not normal smoothing is applied to the
| meshes, creating meshes with an angular, low-poly look via flat
| reflections.
|
| The 'flatshading' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| isomax
| Sets the maximum boundary for iso-surface plot.
|
| The 'isomax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| isomin
| Sets the minimum boundary for iso-surface plot.
|
| The 'isomin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| slices
| The 'slices' property is an instance of Slices
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Slices`
| - A dict of string/value properties that will be passed
| to the Slices constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.isosurface.slices.
| X` instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.isosurface.slices.
| Y` instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.isosurface.slices.
| Z` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.isosurface.Slices
|
| spaceframe
| The 'spaceframe' property is an instance of Spaceframe
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Spaceframe`
| - A dict of string/value properties that will be passed
| to the Spaceframe constructor
|
| Supported dict properties:
|
| fill
| Sets the fill ratio of the `spaceframe`
| elements. The default fill value is 0.15
| meaning that only 15% of the area of every
| faces of tetras would be shaded. Applying a
| greater `fill` ratio would allow the creation
| of stronger elements or could be sued to have
| entirely closed areas (in case of using 1).
| show
| Displays/hides tetrahedron shapes between
| minimum and maximum iso-values. Often useful
| when either caps or surfaces are disabled or
| filled with values less than 1.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Spaceframe
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Stream
|
| surface
| The 'surface' property is an instance of Surface
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Surface`
| - A dict of string/value properties that will be passed
| to the Surface constructor
|
| Supported dict properties:
|
| count
| Sets the number of iso-surfaces between minimum
| and maximum iso-values. By default this value
| is 2 meaning that only minimum and maximum
| surfaces would be drawn.
| fill
| Sets the fill ratio of the iso-surface. The
| default fill value of the surface is 1 meaning
| that they are entirely shaded. On the other
| hand Applying a `fill` ratio less than one
| would allow the creation of openings parallel
| to the edges.
| pattern
| Sets the surface pattern of the iso-surface 3-D
| sections. The default pattern of the surface is
| `all` meaning that the rest of surface elements
| would be shaded. The check options (either 1 or
| 2) could be used to draw half of the squares on
| the surface. Using various combinations of
| capital `A`, `B`, `C`, `D` and `E` may also be
| used to reduce the number of triangles on the
| iso-surfaces and creating other patterns of
| interest.
| show
| Hides/displays surfaces between minimum and
| maximum iso-values.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Surface
|
| text
| Sets the text elements associated with the vertices. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| value
| Sets the 4th dimension (value) of the vertices.
|
| The 'value' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuehoverformat
| Sets the hover text formatting rulefor `value` using d3
| formatting mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'valuehoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| valuesrc
| Sets the source reference on Chart Studio Cloud for `value`.
|
| The 'valuesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the X coordinates of the vertices on X axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the Y coordinates of the vertices on Y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the Z coordinates of the vertices on Z axis.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Layout(plotly.basedatatypes.BaseLayoutType)
| Layout(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)
|
| Method resolution order:
| Layout
| plotly.basedatatypes.BaseLayoutType
| plotly.basedatatypes.BaseLayoutHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)
| Construct a new Layout object
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Layout`
| activeselection
| :class:`plotly.graph_objects.layout.Activeselection`
| instance or dict with compatible properties
| activeshape
| :class:`plotly.graph_objects.layout.Activeshape`
| instance or dict with compatible properties
| annotations
| A tuple of
| :class:`plotly.graph_objects.layout.Annotation`
| instances or dicts with compatible properties
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults), sets the
| default property values to use for elements of
| layout.annotations
| 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.
| autotypenumbers
| Using "strict" a numeric string in trace data is not
| converted to a number. Using *convert types* a numeric
| string in trace data may be treated as a number during
| automatic axis `type` detection. This is the default
| value; however it could be overridden for individual
| axes.
| barcornerradius
| Sets the rounding of bar corners. May be an integer
| number of pixels, or a percentage of bar width (as a
| string ending in %).
| 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 reduce
| "opacity" to see multiple bars.
| barnorm
| Sets the normalization for bar traces on the graph.
| With "fraction", the value of each bar is divided by
| the sum of all values at that location coordinate.
| "percent" is the same but multiplied by 100 to show
| percentages.
| boxgap
| Sets the gap (in plot fraction) between boxes of
| adjacent location coordinates. Has no effect on traces
| that have "width" set.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes of the
| same location coordinate. Has no effect on traces that
| have "width" set.
| boxmode
| Determines how boxes at the same location coordinate
| are displayed on the graph. If "group", the boxes are
| plotted next to one another centered around the shared
| location. If "overlay", the boxes are plotted over one
| another, you might need to set "opacity" to see them
| multiple boxes. Has no effect on traces that have
| "width" set.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout the plot.
| clickmode
| Determines the mode of single click interactions.
| "event" is the default value and emits the
| `plotly_click` event. In addition this mode emits the
| `plotly_selected` event in drag modes "lasso" and
| "select", but with no event data attached (kept for
| compatibility reasons). The "select" flag enables
| selecting single data points via click. This mode also
| supports persistent selections, meaning that pressing
| Shift while clicking, adds to / subtracts from an
| existing selection. "select" with `hovermode`: "x" can
| be confusing, consider explicitly setting `hovermode`:
| "closest" when using this feature. Selection events are
| sent accordingly as long as "event" flag is set as
| well. When the "event" flag is missing, `plotly_click`
| and `plotly_selected` events are not fired.
| coloraxis
| :class:`plotly.graph_objects.layout.Coloraxis` instance
| or dict with compatible properties
| colorscale
| :class:`plotly.graph_objects.layout.Colorscale`
| instance or dict with compatible properties
| colorway
| Sets the default trace colors.
| computed
| Placeholder for exporting automargin-impacting values
| namely `margin.t`, `margin.b`, `margin.l` and
| `margin.r` in "full-json" mode.
| 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.
| 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.
| editrevision
| Controls persistence of user-driven changes in
| `editable: true` configuration, other than trace names
| and axis titles. Defaults to `layout.uirevision`.
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether given
| by `funnelareacolorway` or inherited from `colorway`)
| will be extended to three times its original length by
| first repeating every color 20% lighter then each color
| 20% darker. This is intended to reduce the likelihood
| of reusing the same color when you have many slices,
| but you can set `false` to disable. Colors provided in
| the trace, using `marker.colors`, are never extended.
| extendiciclecolors
| If `true`, the icicle slice colors (whether given by
| `iciclecolorway` or inherited from `colorway`) will be
| extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| extendpiecolors
| If `true`, the pie slice colors (whether given by
| `piecolorway` or inherited from `colorway`) will be
| extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether given by
| `sunburstcolorway` or inherited from `colorway`) will
| be extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| extendtreemapcolors
| If `true`, the treemap slice colors (whether given by
| `treemapcolorway` or inherited from `colorway`) will be
| extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| font
| Sets the global font. Note that fonts used in traces
| and other layout components inherit from the global
| font.
| funnelareacolorway
| Sets the default funnelarea slice colors. Defaults to
| the main `colorway` used for trace colors. If you
| specify a new list here it can still be extended with
| lighter and darker colors, see
| `extendfunnelareacolors`.
| funnelgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of the
| same location coordinate.
| funnelmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "stack", the bars are
| stacked on top of one another With "group", the bars
| are plotted next to one another centered around the
| shared location. With "overlay", the bars are plotted
| over one another, you might need to reduce "opacity" to
| see multiple bars.
| geo
| :class:`plotly.graph_objects.layout.Geo` instance or
| dict with compatible properties
| grid
| :class:`plotly.graph_objects.layout.Grid` instance or
| dict with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart analog of
| visible:'legendonly' but it can contain many labels,
| and can simultaneously hide slices from several
| pies/funnelarea charts
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud 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 Chart Studio
| Cloud (at https://chart-studio.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
| :class:`plotly.graph_objects.layout.Hoverlabel`
| instance or dict with compatible properties
| hovermode
| Determines the mode of hover interactions. If
| "closest", a single hoverlabel will appear for the
| "closest" point within the `hoverdistance`. If "x" (or
| "y"), multiple hoverlabels will appear for multiple
| points at the "closest" x- (or y-) coordinate within
| the `hoverdistance`, with the caveat that no more than
| one hoverlabel will appear per trace. If *x unified*
| (or *y unified*), a single hoverlabel will appear
| multiple points at the closest x- (or y-) coordinate
| within the `hoverdistance` with the caveat that no more
| than one hoverlabel will appear per trace. In this
| mode, spikelines are enabled by default perpendicular
| to the specified axis. If false, hover interactions are
| disabled.
| hoversubplots
| Determines expansion of hover effects to other subplots
| If "single" just the axis pair of the primary point is
| included without overlaying subplots. If "overlaying"
| all subplots using the main axis and occupying the same
| space are included. If "axis", also include stacked
| subplots using the same axis when `hovermode` is set to
| "x", *x unified*, "y" or *y unified*.
| iciclecolorway
| Sets the default icicle slice colors. Defaults to the
| main `colorway` used for trace colors. If you specify a
| new list here it can still be extended with lighter and
| darker colors, see `extendiciclecolors`.
| images
| A tuple of :class:`plotly.graph_objects.layout.Image`
| instances or dicts with compatible properties
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the default
| property values to use for elements of layout.images
| legend
| :class:`plotly.graph_objects.layout.Legend` instance or
| dict with compatible properties
| map
| :class:`plotly.graph_objects.layout.Map` instance or
| dict with compatible properties
| mapbox
| :class:`plotly.graph_objects.layout.Mapbox` instance or
| dict with compatible properties
| margin
| :class:`plotly.graph_objects.layout.Margin` instance or
| dict with compatible properties
| meta
| Assigns extra meta information that can be used in
| various `text` attributes. Attributes such as the
| graph, axis and colorbar `title.text`, annotation
| `text` `trace.name` in legend items, `rangeselector`,
| `updatemenus` and `sliders` `label` text all support
| `meta`. One can access `meta` fields using template
| strings: `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an object
| for example `{key: value}` which can be accessed
| %{meta[key]}.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| minreducedheight
| Minimum height of the plot with margin.automargin
| applied (in px)
| minreducedwidth
| Minimum width of the plot with margin.automargin
| applied (in px)
| modebar
| :class:`plotly.graph_objects.layout.Modebar` instance
| or dict with compatible properties
| newselection
| :class:`plotly.graph_objects.layout.Newselection`
| instance or dict with compatible properties
| newshape
| :class:`plotly.graph_objects.layout.Newshape` instance
| or dict with compatible properties
| paper_bgcolor
| Sets the background color of the paper where the graph
| is drawn.
| piecolorway
| Sets the default pie slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new
| list here it can still be extended with lighter and
| darker colors, see `extendpiecolors`.
| plot_bgcolor
| Sets the background color of the plotting area in-
| between x and y axes.
| polar
| :class:`plotly.graph_objects.layout.Polar` instance or
| dict with compatible properties
| scattergap
| Sets the gap (in plot fraction) between scatter points
| of adjacent location coordinates. Defaults to `bargap`.
| scattermode
| Determines how scatter points at the same location
| coordinate are displayed on the graph. With "group",
| the scatter points are plotted next to one another
| centered around the shared location. With "overlay",
| the scatter points are plotted over one another, you
| might need to reduce "opacity" to see multiple scatter
| points.
| scene
| :class:`plotly.graph_objects.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.
| selectionrevision
| Controls persistence of user-driven changes in selected
| points from all traces.
| selections
| A tuple of
| :class:`plotly.graph_objects.layout.Selection`
| instances or dicts with compatible properties
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets the
| default property values to use for elements of
| layout.selections
| 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
| A tuple of :class:`plotly.graph_objects.layout.Shape`
| instances or dicts with compatible properties
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the default
| property values to use for elements of layout.shapes
| showlegend
| Determines whether or not a legend is drawn. Default is
| `true` if there is a trace to show and any of these: a)
| Two or more traces would by default be shown in the
| legend. b) One pie trace is shown in the legend. c) One
| trace is explicitly given with `showlegend: true`.
| sliders
| A tuple of :class:`plotly.graph_objects.layout.Slider`
| instances or dicts with compatible properties
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets the
| default property values to use for elements of
| layout.sliders
| smith
| :class:`plotly.graph_objects.layout.Smith` 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.
| sunburstcolorway
| Sets the default sunburst slice colors. Defaults to the
| main `colorway` used for trace colors. If you specify a
| new list here it can still be extended with lighter and
| darker colors, see `extendsunburstcolors`.
| template
| Default attributes to be applied to the plot. This
| should be a dict with format: `{'layout':
| layoutTemplate, 'data': {trace_type: [traceTemplate,
| ...], ...}}` where `layoutTemplate` is a dict matching
| the structure of `figure.layout` and `traceTemplate` is
| a dict matching the structure of the trace with type
| `trace_type` (e.g. 'scatter'). Alternatively, this may
| be specified as an instance of
| plotly.graph_objs.layout.Template. Trace templates are
| applied cyclically to traces of each type. Container
| arrays (eg `annotations`) have special handling: An
| object ending in `defaults` (eg `annotationdefaults`)
| is applied to each array item. But if an item has a
| `templateitemname` key we look in the template array
| for an item with matching `name` and apply that
| instead. If no matching `name` is found we mark the
| item invisible. Any named template item not referenced
| is appended to the end of the array, so this can be
| used to add a watermark annotation or a logo image, for
| example. To omit one of these items on the plot, make
| an item with matching `templateitemname` and `visible:
| false`.
| ternary
| :class:`plotly.graph_objects.layout.Ternary` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.layout.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use layout.title.font instead. Sets
| the title font. Note that the title's font used to be
| customized by the now deprecated `titlefont` attribute.
| transition
| Sets transition options used during Plotly.react
| updates.
| treemapcolorway
| Sets the default treemap slice colors. Defaults to the
| main `colorway` used for trace colors. If you specify a
| new list here it can still be extended with lighter and
| darker colors, see `extendtreemapcolors`.
| uirevision
| Used to allow user interactions with the plot to
| persist after `Plotly.react` calls that are unaware of
| these interactions. If `uirevision` is omitted, or if
| it is given and it changed from the previous
| `Plotly.react` call, the exact new figure is used. If
| `uirevision` is truthy and did NOT change, any
| attribute that has been affected by user interactions
| and did not receive a different value in the new figure
| will keep the interaction value. `layout.uirevision`
| attribute serves as the default for `uirevision`
| attributes in various sub-containers. For finer control
| you can set these sub-attributes directly. For example,
| if your app separately controls the data on the x and y
| axes you might set `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y data is
| changed, you can update `yaxis.uirevision=*quantity*`
| and the y axis range will reset but the x axis range
| will retain any user-driven zoom.
| uniformtext
| :class:`plotly.graph_objects.layout.Uniformtext`
| instance or dict with compatible properties
| updatemenus
| A tuple of
| :class:`plotly.graph_objects.layout.Updatemenu`
| instances or dicts with compatible properties
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults), sets the
| default property values to use for elements of
| layout.updatemenus
| violingap
| Sets the gap (in plot fraction) between violins of
| adjacent location coordinates. Has no effect on traces
| that have "width" set.
| violingroupgap
| Sets the gap (in plot fraction) between violins of the
| same location coordinate. Has no effect on traces that
| have "width" set.
| violinmode
| Determines how violins at the same location coordinate
| are displayed on the graph. If "group", the violins are
| plotted next to one another centered around the shared
| location. If "overlay", the violins are plotted over
| one another, you might need to set "opacity" to see
| them multiple violins. Has no effect on traces that
| have "width" set.
| waterfallgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of the
| same location coordinate.
| waterfallmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "group", the bars are
| plotted next to one another centered around the shared
| location. With "overlay", the bars are plotted over one
| another, you might need to reduce "opacity" to see
| multiple bars.
| width
| Sets the plot's width (in px).
| xaxis
| :class:`plotly.graph_objects.layout.XAxis` instance or
| dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.layout.YAxis` instance or
| dict with compatible properties
|
| Returns
| -------
| Layout
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| activeselection
| The 'activeselection' property is an instance of Activeselection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Activeselection`
| - A dict of string/value properties that will be passed
| to the Activeselection constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the color filling the active selection'
| interior.
| opacity
| Sets the opacity of the active selection.
|
| Returns
| -------
| plotly.graph_objs.layout.Activeselection
|
| activeshape
| The 'activeshape' property is an instance of Activeshape
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Activeshape`
| - A dict of string/value properties that will be passed
| to the Activeshape constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the color filling the active shape'
| interior.
| opacity
| Sets the opacity of the active shape.
|
| Returns
| -------
| plotly.graph_objs.layout.Activeshape
|
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults), sets the default
| property values to use for elements of layout.annotations
|
| The 'annotationdefaults' property is an instance of Annotation
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Annotation`
| - A dict of string/value properties that will be passed
| to the Annotation constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Annotation
|
| annotations
| The 'annotations' property is a tuple of instances of
| Annotation that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Annotation
| - A list or tuple of dicts of string/value properties that
| will be passed to the Annotation constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the `text`
| within the box. Has an effect only if `text`
| spans two or more lines (i.e. `text` contains
| one or more <br> HTML tags) or if an explicit
| width is set to override the text width.
| arrowcolor
| Sets the color of the annotation arrow.
| arrowhead
| Sets the end annotation arrow head style.
| arrowside
| Sets the annotation arrow head position.
| arrowsize
| Sets the size of the end annotation arrow head,
| relative to `arrowwidth`. A value of 1
| (default) gives a head about 3x as wide as the
| line.
| arrowwidth
| Sets the width (in px) of annotation arrow
| line.
| ax
| Sets the x component of the arrow tail about
| the arrow head. If `axref` is `pixel`, a
| positive (negative) component corresponds to an
| arrow pointing from right to left (left to
| right). If `axref` is not `pixel` and is
| exactly the same as `xref`, this is an absolute
| value on that axis, like `x`, specified in the
| same coordinates as `xref`.
| axref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position
| refers to a x coordinate. If set to "paper",
| the `x` position refers to the distance from
| the left of the plotting area in normalized
| coordinates where 0 (1) corresponds to the left
| (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the left of the domain of that axis: e.g., *x2
| domain* refers to the domain of the second x
| axis and a x position of 0.5 refers to the
| point between the left and the right of the
| domain of the second x axis. In order for
| absolute positioning of the arrow to work,
| "axref" must be exactly the same as "xref",
| otherwise "axref" will revert to "pixel"
| (explained next). For relative positioning,
| "axref" can be set to "pixel", in which case
| the "ax" value is specified in pixels relative
| to "x". Absolute positioning is useful for
| trendline annotations which should continue to
| indicate the correct trend when zoomed.
| Relative positioning is useful for specifying
| the text offset for an annotated point.
| ay
| Sets the y component of the arrow tail about
| the arrow head. If `ayref` is `pixel`, a
| positive (negative) component corresponds to an
| arrow pointing from bottom to top (top to
| bottom). If `ayref` is not `pixel` and is
| exactly the same as `yref`, this is an absolute
| value on that axis, like `y`, specified in the
| same coordinates as `yref`.
| ayref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position
| refers to a y coordinate. If set to "paper",
| the `y` position refers to the distance from
| the bottom of the plotting area in normalized
| coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the bottom of the domain of that axis: e.g.,
| *y2 domain* refers to the domain of the second
| y axis and a y position of 0.5 refers to the
| point between the bottom and the top of the
| domain of the second y axis. In order for
| absolute positioning of the arrow to work,
| "ayref" must be exactly the same as "yref",
| otherwise "ayref" will revert to "pixel"
| (explained next). For relative positioning,
| "ayref" can be set to "pixel", in which case
| the "ay" value is specified in pixels relative
| to "y". Absolute positioning is useful for
| trendline annotations which should continue to
| indicate the correct trend when zoomed.
| Relative positioning is useful for specifying
| the text offset for an annotated point.
| bgcolor
| Sets the background color of the annotation.
| bordercolor
| Sets the color of the border enclosing the
| annotation `text`.
| borderpad
| Sets the padding (in px) between the `text` and
| the enclosing border.
| borderwidth
| Sets the width (in px) of the border enclosing
| the annotation `text`.
| captureevents
| Determines whether the annotation text box
| captures mouse move and click events, or allows
| those events to pass through to data points in
| the plot that may be behind the annotation. By
| default `captureevents` is False unless
| `hovertext` is provided. If you use the event
| `plotly_clickannotation` without `hovertext`
| you must explicitly enable `captureevents`.
| clicktoshow
| Makes this annotation respond to clicks on the
| plot. If you click a data point that exactly
| matches the `x` and `y` values of this
| annotation, and it is hidden (visible: false),
| it will appear. In "onoff" mode, you must click
| the same point again to make it disappear, so
| if you click multiple points, you can show
| multiple annotations. In "onout" mode, a click
| anywhere else in the plot (on another data
| point or not) will hide this annotation. If you
| need to show/hide this annotation in response
| to different `x` or `y` values, you can set
| `xclick` and/or `yclick`. This is useful for
| example to label the side of a bar. To label
| markers though, `standoff` is preferred over
| `xclick` and `yclick`.
| font
| Sets the annotation text font.
| height
| Sets an explicit height for the text box. null
| (default) lets the text set the box height.
| Taller text will be clipped.
| hoverlabel
| :class:`plotly.graph_objects.layout.annotation.
| Hoverlabel` instance or dict with compatible
| properties
| hovertext
| Sets text to appear when hovering over this
| annotation. If omitted or blank, no hover label
| will appear.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the annotation (text +
| arrow).
| showarrow
| Determines whether or not the annotation is
| drawn with an arrow. If True, `text` is placed
| near the arrow's tail. If False, `text` lines
| up with the `x` and `y` provided.
| standoff
| Sets a distance, in pixels, to move the end
| arrowhead away from the position it is pointing
| at, for example to point at the edge of a
| marker independent of zoom. Note that this
| shortens the arrow from the `ax` / `ay` vector,
| in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| startarrowhead
| Sets the start annotation arrow head style.
| startarrowsize
| Sets the size of the start annotation arrow
| head, relative to `arrowwidth`. A value of 1
| (default) gives a head about 3x as wide as the
| line.
| startstandoff
| Sets a distance, in pixels, to move the start
| arrowhead away from the position it is pointing
| at, for example to point at the edge of a
| marker independent of zoom. Note that this
| shortens the arrow from the `ax` / `ay` vector,
| in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| text
| Sets the text associated with this annotation.
| Plotly uses a subset of HTML tags to do things
| like newline (<br>), bold (<b></b>), italics
| (<i></i>), hyperlinks (<a href='...'></a>).
| Tags <em>, <sup>, <sub>, <s>, <u> <span> are
| also supported.
| textangle
| Sets the angle at which the `text` is drawn
| with respect to the horizontal.
| valign
| Sets the vertical alignment of the `text`
| within the box. Has an effect only if an
| explicit height is set to override the text
| height.
| visible
| Determines whether or not this annotation is
| visible.
| width
| Sets an explicit width for the text box. null
| (default) lets the text set the box width.
| Wider text will be clipped. There is no
| automatic wrapping; use <br> to start a new
| line.
| x
| Sets the annotation's x position. If the axis
| `type` is "log", then you must take the log of
| your desired range. If the axis `type` is
| "date", it should be date strings, like date
| data, though Date objects and unix milliseconds
| will be accepted and converted to strings. If
| the axis `type` is "category", it should be
| numbers, using the scale where each category is
| assigned a serial number from zero in the order
| it appears.
| xanchor
| Sets the text box's horizontal position anchor
| This anchor binds the `x` position to the
| "left", "center" or "right" of the annotation.
| For example, if `x` is set to 1, `xref` to
| "paper" and `xanchor` to "right" then the
| right-most portion of the annotation lines up
| with the right-most edge of the plotting area.
| If "auto", the anchor is equivalent to "center"
| for data-referenced annotations or if there is
| an arrow, whereas for paper-referenced with no
| arrow, the anchor picked corresponds to the
| closest side.
| xclick
| Toggle this annotation when clicking a data
| point whose `x` value is `xclick` rather than
| the annotation's `x` value.
| xref
| Sets the annotation's x coordinate axis. If set
| to a x axis id (e.g. "x" or "x2"), the `x`
| position refers to a x coordinate. If set to
| "paper", the `x` position refers to the
| distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID
| followed by "domain" (separated by a space),
| the position behaves like for "paper", but
| refers to the distance in fractions of the
| domain length from the left of the domain of
| that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position
| of 0.5 refers to the point between the left and
| the right of the domain of the second x axis.
| xshift
| Shifts the position of the whole annotation and
| arrow to the right (positive) or left
| (negative) by this many pixels.
| y
| Sets the annotation's y position. If the axis
| `type` is "log", then you must take the log of
| your desired range. If the axis `type` is
| "date", it should be date strings, like date
| data, though Date objects and unix milliseconds
| will be accepted and converted to strings. If
| the axis `type` is "category", it should be
| numbers, using the scale where each category is
| assigned a serial number from zero in the order
| it appears.
| yanchor
| Sets the text box's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the annotation.
| For example, if `y` is set to 1, `yref` to
| "paper" and `yanchor` to "top" then the top-
| most portion of the annotation lines up with
| the top-most edge of the plotting area. If
| "auto", the anchor is equivalent to "middle"
| for data-referenced annotations or if there is
| an arrow, whereas for paper-referenced with no
| arrow, the anchor picked corresponds to the
| closest side.
| yclick
| Toggle this annotation when clicking a data
| point whose `y` value is `yclick` rather than
| the annotation's `y` value.
| yref
| Sets the annotation's y coordinate axis. If set
| to a y axis id (e.g. "y" or "y2"), the `y`
| position refers to a y coordinate. If set to
| "paper", the `y` position refers to the
| distance from the bottom of the plotting area
| in normalized coordinates where 0 (1)
| corresponds to the bottom (top). If set to a y
| axis ID followed by "domain" (separated by a
| space), the position behaves like for "paper",
| but refers to the distance in fractions of the
| domain length from the bottom of the domain of
| that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position
| of 0.5 refers to the point between the bottom
| and the top of the domain of the second y axis.
| yshift
| Shifts the position of the whole annotation and
| arrow up (positive) or down (negative) by this
| many pixels.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Annotation]
|
| autosize
| Determines whether or not a layout width or height that has
| been left undefined by the user is initialized on each
| relayout. Note that, regardless of this attribute, an undefined
| layout width or height is always initialized on the first call
| to plot.
|
| The 'autosize' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autotypenumbers
| Using "strict" a numeric string in trace data is not converted
| to a number. Using *convert types* a numeric string in trace
| data may be treated as a number during automatic axis `type`
| detection. This is the default value; however it could be
| overridden for individual axes.
|
| The 'autotypenumbers' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['convert types', 'strict']
|
| Returns
| -------
| Any
|
| barcornerradius
| Sets the rounding of bar corners. May be an integer number of
| pixels, or a percentage of bar width (as a string ending in %).
|
| The 'barcornerradius' property accepts values of any type
|
| Returns
| -------
| Any
|
| bargap
| Sets the gap (in plot fraction) between bars of adjacent
| location coordinates.
|
| The 'bargap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| bargroupgap
| Sets the gap (in plot fraction) between bars of the same
| location coordinate.
|
| The 'bargroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| barmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "stack", the bars are stacked on
| top of one another With "relative", the bars are stacked on top
| of one another, with negative values below the axis, positive
| values above With "group", the bars are plotted next to one
| another centered around the shared location. With "overlay",
| the bars are plotted over one another, you might need to reduce
| "opacity" to see multiple bars.
|
| The 'barmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['stack', 'group', 'overlay', 'relative']
|
| Returns
| -------
| Any
|
| barnorm
| Sets the normalization for bar traces on the graph. With
| "fraction", the value of each bar is divided by the sum of all
| values at that location coordinate. "percent" is the same but
| multiplied by 100 to show percentages.
|
| The 'barnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'fraction', 'percent']
|
| Returns
| -------
| Any
|
| boxgap
| Sets the gap (in plot fraction) between boxes of adjacent
| location coordinates. Has no effect on traces that have "width"
| set.
|
| The 'boxgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| boxgroupgap
| Sets the gap (in plot fraction) between boxes of the same
| location coordinate. Has no effect on traces that have "width"
| set.
|
| The 'boxgroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| boxmode
| Determines how boxes at the same location coordinate are
| displayed on the graph. If "group", the boxes are plotted next
| to one another centered around the shared location. If
| "overlay", the boxes are plotted over one another, you might
| need to set "opacity" to see them multiple boxes. Has no effect
| on traces that have "width" set.
|
| The 'boxmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| calendar
| Sets the default calendar system to use for interpreting and
| displaying dates throughout the plot.
|
| The 'calendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| clickmode
| Determines the mode of single click interactions. "event" is
| the default value and emits the `plotly_click` event. In
| addition this mode emits the `plotly_selected` event in drag
| modes "lasso" and "select", but with no event data attached
| (kept for compatibility reasons). The "select" flag enables
| selecting single data points via click. This mode also supports
| persistent selections, meaning that pressing Shift while
| clicking, adds to / subtracts from an existing selection.
| "select" with `hovermode`: "x" can be confusing, consider
| explicitly setting `hovermode`: "closest" when using this
| feature. Selection events are sent accordingly as long as
| "event" flag is set as well. When the "event" flag is missing,
| `plotly_click` and `plotly_selected` events are not fired.
|
| The 'clickmode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['event', 'select'] joined with '+' characters
| (e.g. 'event+select')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| coloraxis
| The 'coloraxis' property is an instance of Coloraxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Coloraxis`
| - A dict of string/value properties that will be passed
| to the Coloraxis constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `colorscale`. In case
| `colorscale` is unspecified or `autocolorscale`
| is true, the default palette will be chosen
| according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| corresponding trace color array(s)) or the
| bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the
| user.
| cmax
| Sets the upper bound of the color domain. Value
| should have the same units as corresponding
| trace color array(s) and if set, `cmin` must be
| set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `cmin` and/or `cmax` to be equidistant
| to this point. Value should have the same units
| as corresponding trace color array(s). Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value
| should have the same units as corresponding
| trace color array(s) and if set, `cmax` must be
| set as well.
| colorbar
| :class:`plotly.graph_objects.layout.coloraxis.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. The colorscale must be an
| array containing arrays mapping a normalized
| value to an rgb, rgba, hex, hsl, hsv, or named
| color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required.
| For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and
| `cmax`. Alternatively, `colorscale` may be a
| palette name string of the following list: Blac
| kbody,Bluered,Blues,Cividis,Earth,Electric,Gree
| ns,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,R
| eds,Viridis,YlGnBu,YlOrRd.
| reversescale
| Reverses the color mapping if true. If true,
| `cmin` will correspond to the last color in the
| array and `cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace.
|
| Returns
| -------
| plotly.graph_objs.layout.Coloraxis
|
| colorscale
| The 'colorscale' property is an instance of Colorscale
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Colorscale`
| - A dict of string/value properties that will be passed
| to the Colorscale constructor
|
| Supported dict properties:
|
| diverging
| Sets the default diverging colorscale. Note
| that `autocolorscale` must be true for this
| attribute to work.
| sequential
| Sets the default sequential colorscale for
| positive values. Note that `autocolorscale`
| must be true for this attribute to work.
| sequentialminus
| Sets the default sequential colorscale for
| negative values. Note that `autocolorscale`
| must be true for this attribute to work.
|
| Returns
| -------
| plotly.graph_objs.layout.Colorscale
|
| colorway
| Sets the default trace colors.
|
| The 'colorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| computed
| Placeholder for exporting automargin-impacting values namely
| `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-
| json" mode.
|
| The 'computed' property accepts values of any type
|
| Returns
| -------
| Any
|
| datarevision
| If provided, a changed value tells `Plotly.react` that one or
| more data arrays has changed. This way you can modify arrays
| in-place rather than making a complete new copy for an
| incremental change. If NOT provided, `Plotly.react` assumes
| that data arrays are being treated as immutable, thus any data
| array with a different identity from its predecessor contains
| new data.
|
| The 'datarevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| dragmode
| Determines the mode of drag interactions. "select" and "lasso"
| apply only to scatter traces with markers or text. "orbit" and
| "turntable" apply only to 3D scenes.
|
| The 'dragmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['zoom', 'pan', 'select', 'lasso', 'drawclosedpath',
| 'drawopenpath', 'drawline', 'drawrect', 'drawcircle',
| 'orbit', 'turntable', False]
|
| Returns
| -------
| Any
|
| editrevision
| Controls persistence of user-driven changes in `editable: true`
| configuration, other than trace names and axis titles. Defaults
| to `layout.uirevision`.
|
| The 'editrevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether given by
| `funnelareacolorway` or inherited from `colorway`) will be
| extended to three times its original length by first repeating
| every color 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing the same color
| when you have many slices, but you can set `false` to disable.
| Colors provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendfunnelareacolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendiciclecolors
| If `true`, the icicle slice colors (whether given by
| `iciclecolorway` or inherited from `colorway`) will be extended
| to three times its original length by first repeating every
| color 20% lighter then each color 20% darker. This is intended
| to reduce the likelihood of reusing the same color when you
| have many slices, but you can set `false` to disable. Colors
| provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendiciclecolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendpiecolors
| If `true`, the pie slice colors (whether given by `piecolorway`
| or inherited from `colorway`) will be extended to three times
| its original length by first repeating every color 20% lighter
| then each color 20% darker. This is intended to reduce the
| likelihood of reusing the same color when you have many slices,
| but you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
|
| The 'extendpiecolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether given by
| `sunburstcolorway` or inherited from `colorway`) will be
| extended to three times its original length by first repeating
| every color 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing the same color
| when you have many slices, but you can set `false` to disable.
| Colors provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendsunburstcolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendtreemapcolors
| If `true`, the treemap slice colors (whether given by
| `treemapcolorway` or inherited from `colorway`) will be
| extended to three times its original length by first repeating
| every color 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing the same color
| when you have many slices, but you can set `false` to disable.
| Colors provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendtreemapcolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| font
| Sets the global font. Note that fonts used in traces and other
| layout components inherit from the global font.
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.layout.Font
|
| funnelareacolorway
| Sets the default funnelarea slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendfunnelareacolors`.
|
| The 'funnelareacolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| funnelgap
| Sets the gap (in plot fraction) between bars of adjacent
| location coordinates.
|
| The 'funnelgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of the same
| location coordinate.
|
| The 'funnelgroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| funnelmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "stack", the bars are stacked on
| top of one another With "group", the bars are plotted next to
| one another centered around the shared location. With
| "overlay", the bars are plotted over one another, you might
| need to reduce "opacity" to see multiple bars.
|
| The 'funnelmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['stack', 'group', 'overlay']
|
| Returns
| -------
| Any
|
| geo
| The 'geo' property is an instance of Geo
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Geo`
| - A dict of string/value properties that will be passed
| to the Geo constructor
|
| Supported dict properties:
|
| bgcolor
| Set the background color of the map
| center
| :class:`plotly.graph_objects.layout.geo.Center`
| instance or dict with compatible properties
| coastlinecolor
| Sets the coastline color.
| coastlinewidth
| Sets the coastline stroke width (in px).
| countrycolor
| Sets line color of the country boundaries.
| countrywidth
| Sets line width (in px) of the country
| boundaries.
| domain
| :class:`plotly.graph_objects.layout.geo.Domain`
| instance or dict with compatible properties
| fitbounds
| Determines if this subplot's view settings are
| auto-computed to fit trace data. On scoped
| maps, setting `fitbounds` leads to `center.lon`
| and `center.lat` getting auto-filled. On maps
| with a non-clipped projection, setting
| `fitbounds` leads to `center.lon`,
| `center.lat`, and `projection.rotation.lon`
| getting auto-filled. On maps with a clipped
| projection, setting `fitbounds` leads to
| `center.lon`, `center.lat`,
| `projection.rotation.lon`,
| `projection.rotation.lat`, `lonaxis.range` and
| `lonaxis.range` getting auto-filled. If
| "locations", only the trace's visible locations
| are considered in the `fitbounds` computations.
| If "geojson", the entire trace input `geojson`
| (if provided) is considered in the `fitbounds`
| computations, Defaults to False.
| framecolor
| Sets the color the frame.
| framewidth
| Sets the stroke width (in px) of the frame.
| lakecolor
| Sets the color of the lakes.
| landcolor
| Sets the land mass color.
| lataxis
| :class:`plotly.graph_objects.layout.geo.Lataxis
| ` instance or dict with compatible properties
| lonaxis
| :class:`plotly.graph_objects.layout.geo.Lonaxis
| ` instance or dict with compatible properties
| oceancolor
| Sets the ocean color
| projection
| :class:`plotly.graph_objects.layout.geo.Project
| ion` instance or dict with compatible
| properties
| resolution
| Sets the resolution of the base layers. The
| values have units of km/mm e.g. 110 corresponds
| to a scale ratio of 1:110,000,000.
| rivercolor
| Sets color of the rivers.
| riverwidth
| Sets the stroke width (in px) of the rivers.
| scope
| Set the scope of the map.
| showcoastlines
| Sets whether or not the coastlines are drawn.
| showcountries
| Sets whether or not country boundaries are
| drawn.
| showframe
| Sets whether or not a frame is drawn around the
| map.
| showlakes
| Sets whether or not lakes are drawn.
| showland
| Sets whether or not land masses are filled in
| color.
| showocean
| Sets whether or not oceans are filled in color.
| showrivers
| Sets whether or not rivers are drawn.
| showsubunits
| Sets whether or not boundaries of subunits
| within countries (e.g. states, provinces) are
| drawn.
| subunitcolor
| Sets the color of the subunits boundaries.
| subunitwidth
| Sets the stroke width (in px) of the subunits
| boundaries.
| uirevision
| Controls persistence of user-driven changes in
| the view (projection and center). Defaults to
| `layout.uirevision`.
| visible
| Sets the default visibility of the base layers.
|
| Returns
| -------
| plotly.graph_objs.layout.Geo
|
| grid
| The 'grid' property is an instance of Grid
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Grid`
| - A dict of string/value properties that will be passed
| to the Grid constructor
|
| Supported dict properties:
|
| columns
| The number of columns in the grid. If you
| provide a 2D `subplots` array, the length of
| its longest row is used as the default. If you
| give an `xaxes` array, its length is used as
| the default. But it's also possible to have a
| different length, if you want to leave a row at
| the end for non-cartesian subplots.
| domain
| :class:`plotly.graph_objects.layout.grid.Domain
| ` instance or dict with compatible properties
| pattern
| If no `subplots`, `xaxes`, or `yaxes` are given
| but we do have `rows` and `columns`, we can
| generate defaults using consecutive axis IDs,
| in two ways: "coupled" gives one x axis per
| column and one y axis per row. "independent"
| uses a new xy pair for each cell, left-to-right
| across each row then iterating rows according
| to `roworder`.
| roworder
| Is the first row the top or the bottom? Note
| that columns are always enumerated from left to
| right.
| rows
| The number of rows in the grid. If you provide
| a 2D `subplots` array or a `yaxes` array, its
| length is used as the default. But it's also
| possible to have a different length, if you
| want to leave a row at the end for non-
| cartesian subplots.
| subplots
| Used for freeform grids, where some axes may be
| shared across subplots but others are not. Each
| entry should be a cartesian subplot id, like
| "xy" or "x3y2", or "" to leave that cell empty.
| You may reuse x axes within the same column,
| and y axes within the same row. Non-cartesian
| subplots and traces that support `domain` can
| place themselves in this grid separately using
| the `gridcell` attribute.
| xaxes
| Used with `yaxes` when the x and y axes are
| shared across columns and rows. Each entry
| should be an x axis id like "x", "x2", etc., or
| "" to not put an x axis in that column. Entries
| other than "" must be unique. Ignored if
| `subplots` is present. If missing but `yaxes`
| is present, will generate consecutive IDs.
| xgap
| Horizontal space between grid cells, expressed
| as a fraction of the total width available to
| one cell. Defaults to 0.1 for coupled-axes
| grids and 0.2 for independent grids.
| xside
| Sets where the x axis labels and titles go.
| "bottom" means the very bottom of the grid.
| "bottom plot" is the lowest plot that each x
| axis is used in. "top" and "top plot" are
| similar.
| yaxes
| Used with `yaxes` when the x and y axes are
| shared across columns and rows. Each entry
| should be an y axis id like "y", "y2", etc., or
| "" to not put a y axis in that row. Entries
| other than "" must be unique. Ignored if
| `subplots` is present. If missing but `xaxes`
| is present, will generate consecutive IDs.
| ygap
| Vertical space between grid cells, expressed as
| a fraction of the total height available to one
| cell. Defaults to 0.1 for coupled-axes grids
| and 0.3 for independent grids.
| yside
| Sets where the y axis labels and titles go.
| "left" means the very left edge of the grid.
| *left plot* is the leftmost plot that each y
| axis is used in. "right" and *right plot* are
| similar.
|
| Returns
| -------
| plotly.graph_objs.layout.Grid
|
| height
| Sets the plot's height (in px).
|
| The 'height' property is a number and may be specified as:
| - An int or float in the interval [10, inf]
|
| Returns
| -------
| int|float
|
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart analog of
| visible:'legendonly' but it can contain many labels, and can
| simultaneously hide slices from several pies/funnelarea charts
|
| The 'hiddenlabels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud for
| `hiddenlabels`.
|
| The 'hiddenlabelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hidesources
| Determines whether or not a text link citing the data source is
| placed at the bottom-right cored of the figure. Has only an
| effect only on graphs that have been generated via forked
| graphs from the Chart Studio Cloud (at https://chart-
| studio.plotly.com or on-premise).
|
| The 'hidesources' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverdistance
| Sets the default distance (in pixels) to look for data to add
| hover labels (-1 means no cutoff, 0 means no looking for data).
| This is only a real distance for hovering on point-like
| objects, like scatter points. For area-like objects (bars,
| scatter fills, etc) hovering is on inside the area and off
| outside, but these objects will not supersede hover on point-
| like objects in case of conflict.
|
| The 'hoverdistance' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [-1, 9223372036854775807]
|
| Returns
| -------
| int
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| bgcolor
| Sets the background color of all hover labels
| on graph
| bordercolor
| Sets the border color of all hover labels on
| graph.
| font
| Sets the default hover label font used by all
| traces on the graph.
| grouptitlefont
| Sets the font for group titles in hover
| (unified modes). Defaults to `hoverlabel.font`.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
|
| Returns
| -------
| plotly.graph_objs.layout.Hoverlabel
|
| hovermode
| Determines the mode of hover interactions. If "closest", a
| single hoverlabel will appear for the "closest" point within
| the `hoverdistance`. If "x" (or "y"), multiple hoverlabels will
| appear for multiple points at the "closest" x- (or y-)
| coordinate within the `hoverdistance`, with the caveat that no
| more than one hoverlabel will appear per trace. If *x unified*
| (or *y unified*), a single hoverlabel will appear multiple
| points at the closest x- (or y-) coordinate within the
| `hoverdistance` with the caveat that no more than one
| hoverlabel will appear per trace. In this mode, spikelines are
| enabled by default perpendicular to the specified axis. If
| false, hover interactions are disabled.
|
| The 'hovermode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['x', 'y', 'closest', False, 'x unified', 'y unified']
|
| Returns
| -------
| Any
|
| hoversubplots
| Determines expansion of hover effects to other subplots If
| "single" just the axis pair of the primary point is included
| without overlaying subplots. If "overlaying" all subplots using
| the main axis and occupying the same space are included. If
| "axis", also include stacked subplots using the same axis when
| `hovermode` is set to "x", *x unified*, "y" or *y unified*.
|
| The 'hoversubplots' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['single', 'overlaying', 'axis']
|
| Returns
| -------
| Any
|
| iciclecolorway
| Sets the default icicle slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendiciclecolors`.
|
| The 'iciclecolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the default
| property values to use for elements of layout.images
|
| The 'imagedefaults' property is an instance of Image
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Image`
| - A dict of string/value properties that will be passed
| to the Image constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Image
|
| images
| The 'images' property is a tuple of instances of
| Image that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Image
| - A list or tuple of dicts of string/value properties that
| will be passed to the Image constructor
|
| Supported dict properties:
|
| layer
| Specifies whether images are drawn below or
| above traces. When `xref` and `yref` are both
| set to `paper`, image is drawn below the entire
| plot area.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the image.
| sizex
| Sets the image container size horizontally. The
| image will be sized based on the `position`
| value. When `xref` is set to `paper`, units are
| sized relative to the plot width. When `xref`
| ends with ` domain`, units are sized relative
| to the axis width.
| sizey
| Sets the image container size vertically. The
| image will be sized based on the `position`
| value. When `yref` is set to `paper`, units are
| sized relative to the plot height. When `yref`
| ends with ` domain`, units are sized relative
| to the axis height.
| sizing
| Specifies which dimension of the image to
| constrain.
| source
| Specifies the URL of the image to be used. The
| URL must be accessible from the domain where
| the plot code is run, and can be either
| relative or absolute.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| visible
| Determines whether or not this image is
| visible.
| x
| Sets the image's x position. When `xref` is set
| to `paper`, units are sized relative to the
| plot height. See `xref` for more info
| xanchor
| Sets the anchor for the x position
| xref
| Sets the images's x coordinate axis. If set to
| a x axis id (e.g. "x" or "x2"), the `x`
| position refers to a x coordinate. If set to
| "paper", the `x` position refers to the
| distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID
| followed by "domain" (separated by a space),
| the position behaves like for "paper", but
| refers to the distance in fractions of the
| domain length from the left of the domain of
| that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position
| of 0.5 refers to the point between the left and
| the right of the domain of the second x axis.
| y
| Sets the image's y position. When `yref` is set
| to `paper`, units are sized relative to the
| plot height. See `yref` for more info
| yanchor
| Sets the anchor for the y position.
| yref
| Sets the images's y coordinate axis. If set to
| a y axis id (e.g. "y" or "y2"), the `y`
| position refers to a y coordinate. If set to
| "paper", the `y` position refers to the
| distance from the bottom of the plotting area
| in normalized coordinates where 0 (1)
| corresponds to the bottom (top). If set to a y
| axis ID followed by "domain" (separated by a
| space), the position behaves like for "paper",
| but refers to the distance in fractions of the
| domain length from the bottom of the domain of
| that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position
| of 0.5 refers to the point between the bottom
| and the top of the domain of the second y axis.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Image]
|
| legend
| The 'legend' property is an instance of Legend
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Legend`
| - A dict of string/value properties that will be passed
| to the Legend constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the legend background color. Defaults to
| `layout.paper_bgcolor`.
| bordercolor
| Sets the color of the border enclosing the
| legend.
| borderwidth
| Sets the width (in px) of the border enclosing
| the legend.
| entrywidth
| Sets the width (in px or fraction) of the
| legend. Use 0 to size the entry based on the
| text width, when `entrywidthmode` is set to
| "pixels".
| entrywidthmode
| Determines what entrywidth means.
| font
| Sets the font used to text the legend items.
| groupclick
| Determines the behavior on legend group item
| click. "toggleitem" toggles the visibility of
| the individual item clicked on the graph.
| "togglegroup" toggles the visibility of all
| items in the same legendgroup as the item
| clicked on the graph.
| grouptitlefont
| Sets the font for group titles in legend.
| Defaults to `legend.font` with its size
| increased about 10%.
| indentation
| Sets the indentation (in px) of the legend
| entries.
| itemclick
| Determines the behavior on legend item click.
| "toggle" toggles the visibility of the item
| clicked on the graph. "toggleothers" makes the
| clicked item the sole visible item on the
| graph. False disables legend item click
| interactions.
| itemdoubleclick
| Determines the behavior on legend item double-
| click. "toggle" toggles the visibility of the
| item clicked on the graph. "toggleothers" makes
| the clicked item the sole visible item on the
| graph. False disables legend item double-click
| interactions.
| itemsizing
| Determines if the legend items symbols scale
| with their corresponding "trace" attributes or
| remain "constant" independent of the symbol
| size on the graph.
| itemwidth
| Sets the width (in px) of the legend item
| symbols (the part other than the title.text).
| orientation
| Sets the orientation of the legend.
| title
| :class:`plotly.graph_objects.layout.legend.Titl
| e` instance or dict with compatible properties
| tracegroupgap
| Sets the amount of vertical space (in px)
| between legend groups.
| traceorder
| Determines the order at which the legend items
| are displayed. If "normal", the items are
| displayed top-to-bottom in the same order as
| the input data. If "reversed", the items are
| displayed in the opposite order as "normal". If
| "grouped", the items are displayed in groups
| (when a trace `legendgroup` is provided). if
| "grouped+reversed", the items are displayed in
| the opposite order as "grouped".
| uirevision
| Controls persistence of legend-driven changes
| in trace and pie label visibility. Defaults to
| `layout.uirevision`.
| valign
| Sets the vertical alignment of the symbols with
| respect to their associated text.
| visible
| Determines whether or not this legend is
| visible.
| x
| Sets the x position with respect to `xref` (in
| normalized coordinates) of the legend. When
| `xref` is "paper", defaults to 1.02 for
| vertical legends and defaults to 0 for
| horizontal legends. When `xref` is "container",
| defaults to 1 for vertical legends and defaults
| to 0 for horizontal legends. Must be between 0
| and 1 if `xref` is "container". and between
| "-2" and 3 if `xref` is "paper".
| xanchor
| Sets the legend's horizontal position anchor.
| This anchor binds the `x` position to the
| "left", "center" or "right" of the legend.
| Value "auto" anchors legends to the right for
| `x` values greater than or equal to 2/3,
| anchors legends to the left for `x` values less
| than or equal to 1/3 and anchors legends with
| respect to their center otherwise.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` (in
| normalized coordinates) of the legend. When
| `yref` is "paper", defaults to 1 for vertical
| legends, defaults to "-0.1" for horizontal
| legends on graphs w/o range sliders and
| defaults to 1.1 for horizontal legends on graph
| with one or multiple range sliders. When `yref`
| is "container", defaults to 1. Must be between
| 0 and 1 if `yref` is "container" and between
| "-2" and 3 if `yref` is "paper".
| yanchor
| Sets the legend's vertical position anchor This
| anchor binds the `y` position to the "top",
| "middle" or "bottom" of the legend. Value
| "auto" anchors legends at their bottom for `y`
| values less than or equal to 1/3, anchors
| legends to at their top for `y` values greater
| than or equal to 2/3 and anchors legends with
| respect to their middle otherwise.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.layout.Legend
|
| map
| The 'map' property is an instance of Map
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Map`
| - A dict of string/value properties that will be passed
| to the Map constructor
|
| Supported dict properties:
|
| bearing
| Sets the bearing angle of the map in degrees
| counter-clockwise from North (map.bearing).
| bounds
| :class:`plotly.graph_objects.layout.map.Bounds`
| instance or dict with compatible properties
| center
| :class:`plotly.graph_objects.layout.map.Center`
| instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.map.Domain`
| instance or dict with compatible properties
| layers
| A tuple of
| :class:`plotly.graph_objects.layout.map.Layer`
| instances or dicts with compatible properties
| layerdefaults
| When used in a template (as
| layout.template.layout.map.layerdefaults), sets
| the default property values to use for elements
| of layout.map.layers
| pitch
| Sets the pitch angle of the map (in degrees,
| where 0 means perpendicular to the surface of
| the map) (map.pitch).
| style
| Defines the map layers that are rendered by
| default below the trace layers defined in
| `data`, which are themselves by default
| rendered below the layers defined in
| `layout.map.layers`. These layers can be
| defined either explicitly as a Map Style object
| which can contain multiple layer definitions
| that load data from any public or private Tile
| Map Service (TMS or XYZ) or Web Map Service
| (WMS) or implicitly by using one of the built-
| in style objects which use WMSes or by using a
| custom style URL Map Style objects are of the
| form described in the MapLibre GL JS
| documentation available at
| https://maplibre.org/maplibre-style-spec/ The
| built-in plotly.js styles objects are: basic,
| carto-darkmatter, carto-darkmatter-nolabels,
| carto-positron, carto-positron-nolabels, carto-
| voyager, carto-voyager-nolabels, dark, light,
| open-street-map, outdoors, satellite,
| satellite-streets, streets, white-bg.
| uirevision
| Controls persistence of user-driven changes in
| the view: `center`, `zoom`, `bearing`, `pitch`.
| Defaults to `layout.uirevision`.
| zoom
| Sets the zoom level of the map (map.zoom).
|
| Returns
| -------
| plotly.graph_objs.layout.Map
|
| mapbox
| The 'mapbox' property is an instance of Mapbox
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Mapbox`
| - A dict of string/value properties that will be passed
| to the Mapbox constructor
|
| Supported dict properties:
|
| accesstoken
| Sets the mapbox access token to be used for
| this mapbox map. Alternatively, the mapbox
| access token can be set in the configuration
| options under `mapboxAccessToken`. Note that
| accessToken are only required when `style` (e.g
| with values : basic, streets, outdoors, light,
| dark, satellite, satellite-streets ) and/or a
| layout layer references the Mapbox server.
| bearing
| Sets the bearing angle of the map in degrees
| counter-clockwise from North (mapbox.bearing).
| bounds
| :class:`plotly.graph_objects.layout.mapbox.Boun
| ds` instance or dict with compatible properties
| center
| :class:`plotly.graph_objects.layout.mapbox.Cent
| er` instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.mapbox.Doma
| in` instance or dict with compatible properties
| layers
| A tuple of :class:`plotly.graph_objects.layout.
| mapbox.Layer` instances or dicts with
| compatible properties
| layerdefaults
| When used in a template (as
| layout.template.layout.mapbox.layerdefaults),
| sets the default property values to use for
| elements of layout.mapbox.layers
| pitch
| Sets the pitch angle of the map (in degrees,
| where 0 means perpendicular to the surface of
| the map) (mapbox.pitch).
| style
| Defines the map layers that are rendered by
| default below the trace layers defined in
| `data`, which are themselves by default
| rendered below the layers defined in
| `layout.mapbox.layers`. These layers can be
| defined either explicitly as a Mapbox Style
| object which can contain multiple layer
| definitions that load data from any public or
| private Tile Map Service (TMS or XYZ) or Web
| Map Service (WMS) or implicitly by using one of
| the built-in style objects which use WMSes
| which do not require any access tokens, or by
| using a default Mapbox style or custom Mapbox
| style URL, both of which require a Mapbox
| access token Note that Mapbox access token can
| be set in the `accesstoken` attribute or in the
| `mapboxAccessToken` config option. Mapbox
| Style objects are of the form described in the
| Mapbox GL JS documentation available at
| https://docs.mapbox.com/mapbox-gl-js/style-spec
| The built-in plotly.js styles objects are:
| carto-darkmatter, carto-positron, open-street-
| map, stamen-terrain, stamen-toner, stamen-
| watercolor, white-bg The built-in Mapbox
| styles are: basic, streets, outdoors, light,
| dark, satellite, satellite-streets Mapbox
| style URLs are of the form:
| mapbox://mapbox.mapbox-<name>-<version>
| uirevision
| Controls persistence of user-driven changes in
| the view: `center`, `zoom`, `bearing`, `pitch`.
| Defaults to `layout.uirevision`.
| zoom
| Sets the zoom level of the map (mapbox.zoom).
|
| Returns
| -------
| plotly.graph_objs.layout.Mapbox
|
| margin
| The 'margin' property is an instance of Margin
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Margin`
| - A dict of string/value properties that will be passed
| to the Margin constructor
|
| Supported dict properties:
|
| autoexpand
| Turns on/off margin expansion computations.
| Legends, colorbars, updatemenus, sliders, axis
| rangeselector and rangeslider are allowed to
| push the margins by defaults.
| b
| Sets the bottom margin (in px).
| l
| Sets the left margin (in px).
| pad
| Sets the amount of padding (in px) between the
| plotting area and the axis lines
| r
| Sets the right margin (in px).
| t
| Sets the top margin (in px).
|
| Returns
| -------
| plotly.graph_objs.layout.Margin
|
| meta
| Assigns extra meta information that can be used in various
| `text` attributes. Attributes such as the graph, axis and
| colorbar `title.text`, annotation `text` `trace.name` in legend
| items, `rangeselector`, `updatemenus` and `sliders` `label`
| text all support `meta`. One can access `meta` fields using
| template strings: `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an object for
| example `{key: value}` which can be accessed %{meta[key]}.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| minreducedheight
| Minimum height of the plot with margin.automargin applied (in
| px)
|
| The 'minreducedheight' property is a number and may be specified as:
| - An int or float in the interval [2, inf]
|
| Returns
| -------
| int|float
|
| minreducedwidth
| Minimum width of the plot with margin.automargin applied (in
| px)
|
| The 'minreducedwidth' property is a number and may be specified as:
| - An int or float in the interval [2, inf]
|
| Returns
| -------
| int|float
|
| modebar
| The 'modebar' property is an instance of Modebar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Modebar`
| - A dict of string/value properties that will be passed
| to the Modebar constructor
|
| Supported dict properties:
|
| activecolor
| Sets the color of the active or hovered on
| icons in the modebar.
| add
| Determines which predefined modebar buttons to
| add. Please note that these buttons will only
| be shown if they are compatible with all trace
| types used in a graph. Similar to
| `config.modeBarButtonsToAdd` option. This may
| include "v1hovermode", "hoverclosest",
| "hovercompare", "togglehover",
| "togglespikelines", "drawline", "drawopenpath",
| "drawclosedpath", "drawcircle", "drawrect",
| "eraseshape".
| addsrc
| Sets the source reference on Chart Studio Cloud
| for `add`.
| bgcolor
| Sets the background color of the modebar.
| color
| Sets the color of the icons in the modebar.
| orientation
| Sets the orientation of the modebar.
| remove
| Determines which predefined modebar buttons to
| remove. Similar to
| `config.modeBarButtonsToRemove` option. This
| may include "autoScale2d", "autoscale",
| "editInChartStudio", "editinchartstudio",
| "hoverCompareCartesian", "hovercompare",
| "lasso", "lasso2d", "orbitRotation",
| "orbitrotation", "pan", "pan2d", "pan3d",
| "reset", "resetCameraDefault3d",
| "resetCameraLastSave3d", "resetGeo",
| "resetSankeyGroup", "resetScale2d",
| "resetViewMap", "resetViewMapbox",
| "resetViews", "resetcameradefault",
| "resetcameralastsave", "resetsankeygroup",
| "resetscale", "resetview", "resetviews",
| "select", "select2d", "sendDataToCloud",
| "senddatatocloud", "tableRotation",
| "tablerotation", "toImage", "toggleHover",
| "toggleSpikelines", "togglehover",
| "togglespikelines", "toimage", "zoom",
| "zoom2d", "zoom3d", "zoomIn2d", "zoomInGeo",
| "zoomInMap", "zoomInMapbox", "zoomOut2d",
| "zoomOutGeo", "zoomOutMap", "zoomOutMapbox",
| "zoomin", "zoomout".
| removesrc
| Sets the source reference on Chart Studio Cloud
| for `remove`.
| uirevision
| Controls persistence of user-driven changes
| related to the modebar, including `hovermode`,
| `dragmode`, and `showspikes` at both the root
| level and inside subplots. Defaults to
| `layout.uirevision`.
|
| Returns
| -------
| plotly.graph_objs.layout.Modebar
|
| newselection
| The 'newselection' property is an instance of Newselection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Newselection`
| - A dict of string/value properties that will be passed
| to the Newselection constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.layout.newselectio
| n.Line` instance or dict with compatible
| properties
| mode
| Describes how a new selection is created. If
| `immediate`, a new selection is created after
| first mouse up. If `gradual`, a new selection
| is not created after first mouse. By adding to
| and subtracting from the initial selection,
| this option allows declaring extra outlines of
| the selection.
|
| Returns
| -------
| plotly.graph_objs.layout.Newselection
|
| newshape
| The 'newshape' property is an instance of Newshape
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Newshape`
| - A dict of string/value properties that will be passed
| to the Newshape constructor
|
| Supported dict properties:
|
| drawdirection
| When `dragmode` is set to "drawrect",
| "drawline" or "drawcircle" this limits the drag
| to be horizontal, vertical or diagonal. Using
| "diagonal" there is no limit e.g. in drawing
| lines in any direction. "ortho" limits the draw
| to be either horizontal or vertical.
| "horizontal" allows horizontal extend.
| "vertical" allows vertical extend.
| fillcolor
| Sets the color filling new shapes' interior.
| Please note that if using a fillcolor with
| alpha greater than half, drag inside the active
| shape starts moving the shape underneath,
| otherwise a new shape could be started over.
| fillrule
| Determines the path's interior. For more info
| please visit https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.newshape.La
| bel` instance or dict with compatible
| properties
| layer
| Specifies whether new shapes are drawn below
| gridlines ("below"), between gridlines and
| traces ("between") or above traces ("above").
| legend
| Sets the reference to a legend to show new
| shape in. References to these legends are
| "legend", "legend2", "legend3", etc. Settings
| for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
| legendgroup
| Sets the legend group for new shape. Traces and
| shapes part of the same legend group hide/show
| at the same time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.newshape.Le
| gendgrouptitle` instance or dict with
| compatible properties
| legendrank
| Sets the legend rank for new shape. Items and
| groups with smaller ranks are presented on
| top/left side while with "reversed"
| `legend.traceorder` they are on bottom/right
| side. The default legendrank is 1000, so that
| you can use ranks less than 1000 to place
| certain items before all unranked items, and
| ranks greater than 1000 to go after all
| unranked items.
| legendwidth
| Sets the width (in px or fraction) of the
| legend for new shape.
| line
| :class:`plotly.graph_objects.layout.newshape.Li
| ne` instance or dict with compatible properties
| name
| Sets new shape name. The name appears as the
| legend item.
| opacity
| Sets the opacity of new shapes.
| showlegend
| Determines whether or not new shape is shown in
| the legend.
| visible
| Determines whether or not new shape is visible.
| If "legendonly", the shape is not drawn, but
| can appear as a legend item (provided that the
| legend itself is visible).
|
| Returns
| -------
| plotly.graph_objs.layout.Newshape
|
| paper_bgcolor
| Sets the background color of the paper where the graph is
| drawn.
|
| The 'paper_bgcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| piecolorway
| Sets the default pie slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendpiecolors`.
|
| The 'piecolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| plot_bgcolor
| Sets the background color of the plotting area in-between x and
| y axes.
|
| The 'plot_bgcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| polar
| The 'polar' property is an instance of Polar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Polar`
| - A dict of string/value properties that will be passed
| to the Polar constructor
|
| Supported dict properties:
|
| angularaxis
| :class:`plotly.graph_objects.layout.polar.Angul
| arAxis` instance or dict with compatible
| properties
| bargap
| Sets the gap between bars of adjacent location
| coordinates. Values are unitless, they
| represent fractions of the minimum difference
| in bar positions in the data.
| barmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "stack", the bars are stacked on top of one
| another With "overlay", the bars are plotted
| over one another, you might need to reduce
| "opacity" to see multiple bars.
| bgcolor
| Set the background color of the subplot
| domain
| :class:`plotly.graph_objects.layout.polar.Domai
| n` instance or dict with compatible properties
| gridshape
| Determines if the radial axis grid lines and
| angular axis line are drawn as "circular"
| sectors or as "linear" (polygon) sectors. Has
| an effect only when the angular axis has `type`
| "category". Note that `radialaxis.angle` is
| snapped to the angle of the closest vertex when
| `gridshape` is "circular" (so that radial axis
| scale is the same as the data scale).
| hole
| Sets the fraction of the radius to cut out of
| the polar subplot.
| radialaxis
| :class:`plotly.graph_objects.layout.polar.Radia
| lAxis` instance or dict with compatible
| properties
| sector
| Sets angular span of this polar subplot with
| two angles (in degrees). Sector are assumed to
| be spanned in the counterclockwise direction
| with 0 corresponding to rightmost limit of the
| polar subplot.
| uirevision
| Controls persistence of user-driven changes in
| axis attributes, if not overridden in the
| individual axes. Defaults to
| `layout.uirevision`.
|
| Returns
| -------
| plotly.graph_objs.layout.Polar
|
| scattergap
| Sets the gap (in plot fraction) between scatter points of
| adjacent location coordinates. Defaults to `bargap`.
|
| The 'scattergap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| scattermode
| Determines how scatter points at the same location coordinate
| are displayed on the graph. With "group", the scatter points
| are plotted next to one another centered around the shared
| location. With "overlay", the scatter points are plotted over
| one another, you might need to reduce "opacity" to see multiple
| scatter points.
|
| The 'scattermode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| scene
| The 'scene' property is an instance of Scene
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Scene`
| - A dict of string/value properties that will be passed
| to the Scene constructor
|
| Supported dict properties:
|
| annotations
| A tuple of :class:`plotly.graph_objects.layout.
| scene.Annotation` instances or dicts with
| compatible properties
| annotationdefaults
| When used in a template (as layout.template.lay
| out.scene.annotationdefaults), sets the default
| property values to use for elements of
| layout.scene.annotations
| aspectmode
| If "cube", this scene's axes are drawn as a
| cube, regardless of the axes' ranges. If
| "data", this scene's axes are drawn in
| proportion with the axes' ranges. If "manual",
| this scene's axes are drawn in proportion with
| the input of "aspectratio" (the default
| behavior if "aspectratio" is provided). If
| "auto", this scene's axes are drawn using the
| results of "data" except when one axis is more
| than four times the size of the two others,
| where in that case the results of "cube" are
| used.
| aspectratio
| Sets this scene's axis aspectratio.
| bgcolor
|
| camera
| :class:`plotly.graph_objects.layout.scene.Camer
| a` instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.scene.Domai
| n` instance or dict with compatible properties
| dragmode
| Determines the mode of drag interactions for
| this scene.
| hovermode
| Determines the mode of hover interactions for
| this scene.
| uirevision
| Controls persistence of user-driven changes in
| camera attributes. Defaults to
| `layout.uirevision`.
| xaxis
| :class:`plotly.graph_objects.layout.scene.XAxis
| ` instance or dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.layout.scene.YAxis
| ` instance or dict with compatible properties
| zaxis
| :class:`plotly.graph_objects.layout.scene.ZAxis
| ` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.layout.Scene
|
| selectdirection
| When `dragmode` is set to "select", this limits the selection
| of the drag to horizontal, vertical or diagonal. "h" only
| allows horizontal selection, "v" only vertical, "d" only
| diagonal and "any" sets no limit.
|
| The 'selectdirection' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['h', 'v', 'd', 'any']
|
| Returns
| -------
| Any
|
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets the default
| property values to use for elements of layout.selections
|
| The 'selectiondefaults' property is an instance of Selection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Selection`
| - A dict of string/value properties that will be passed
| to the Selection constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Selection
|
| selectionrevision
| Controls persistence of user-driven changes in selected points
| from all traces.
|
| The 'selectionrevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| selections
| The 'selections' property is a tuple of instances of
| Selection that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Selection
| - A list or tuple of dicts of string/value properties that
| will be passed to the Selection constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.layout.selection.L
| ine` instance or dict with compatible
| properties
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the selection.
| path
| For `type` "path" - a valid SVG path similar to
| `shapes.path` in data coordinates. Allowed
| segments are: M, L and Z.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| type
| Specifies the selection type to be drawn. If
| "rect", a rectangle is drawn linking
| (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`) and
| (`x0`,`y1`). If "path", draw a custom SVG path
| using `path`.
| x0
| Sets the selection's starting x position.
| x1
| Sets the selection's end x position.
| xref
| Sets the selection's x coordinate axis. If set
| to a x axis id (e.g. "x" or "x2"), the `x`
| position refers to a x coordinate. If set to
| "paper", the `x` position refers to the
| distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID
| followed by "domain" (separated by a space),
| the position behaves like for "paper", but
| refers to the distance in fractions of the
| domain length from the left of the domain of
| that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position
| of 0.5 refers to the point between the left and
| the right of the domain of the second x axis.
| y0
| Sets the selection's starting y position.
| y1
| Sets the selection's end y position.
| yref
| Sets the selection's x coordinate axis. If set
| to a y axis id (e.g. "y" or "y2"), the `y`
| position refers to a y coordinate. If set to
| "paper", the `y` position refers to the
| distance from the bottom of the plotting area
| in normalized coordinates where 0 (1)
| corresponds to the bottom (top). If set to a y
| axis ID followed by "domain" (separated by a
| space), the position behaves like for "paper",
| but refers to the distance in fractions of the
| domain length from the bottom of the domain of
| that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position
| of 0.5 refers to the point between the bottom
| and the top of the domain of the second y axis.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Selection]
|
| separators
| Sets the decimal and thousand separators. For example, *. *
| puts a '.' before decimals and a space between thousands. In
| English locales, dflt is ".," but other locales may alter this
| default.
|
| The 'separators' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the default
| property values to use for elements of layout.shapes
|
| The 'shapedefaults' property is an instance of Shape
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Shape`
| - A dict of string/value properties that will be passed
| to the Shape constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Shape
|
| shapes
| The 'shapes' property is a tuple of instances of
| Shape that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Shape
| - A list or tuple of dicts of string/value properties that
| will be passed to the Shape constructor
|
| Supported dict properties:
|
| editable
| Determines whether the shape could be activated
| for edit or not. Has no effect when the older
| editable shapes mode is enabled via
| `config.editable` or
| `config.edits.shapePosition`.
| fillcolor
| Sets the color filling the shape's interior.
| Only applies to closed shapes.
| fillrule
| Determines which regions of complex paths
| constitute the interior. For more info please
| visit https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.shape.Label
| ` instance or dict with compatible properties
| layer
| Specifies whether shapes are drawn below
| gridlines ("below"), between gridlines and
| traces ("between") or above traces ("above").
| legend
| Sets the reference to a legend to show this
| shape in. References to these legends are
| "legend", "legend2", "legend3", etc. Settings
| for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
| legendgroup
| Sets the legend group for this shape. Traces
| and shapes part of the same legend group
| hide/show at the same time when toggling legend
| items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.shape.Legen
| dgrouptitle` instance or dict with compatible
| properties
| legendrank
| Sets the legend rank for this shape. Items and
| groups with smaller ranks are presented on
| top/left side while with "reversed"
| `legend.traceorder` they are on bottom/right
| side. The default legendrank is 1000, so that
| you can use ranks less than 1000 to place
| certain items before all unranked items, and
| ranks greater than 1000 to go after all
| unranked items. When having unranked or equal
| rank items shapes would be displayed after
| traces i.e. according to their order in data
| and layout.
| legendwidth
| Sets the width (in px or fraction) of the
| legend for this shape.
| line
| :class:`plotly.graph_objects.layout.shape.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the shape.
| path
| For `type` "path" - a valid SVG path with the
| pixel values replaced by data values in
| `xsizemode`/`ysizemode` being "scaled" and
| taken unmodified as pixels relative to
| `xanchor` and `yanchor` in case of "pixel" size
| mode. There are a few restrictions / quirks
| only absolute instructions, not relative. So
| the allowed segments are: M, L, H, V, Q, C, T,
| S, and Z arcs (A) are not allowed because
| radius rx and ry are relative. In the future we
| could consider supporting relative commands,
| but we would have to decide on how to handle
| date and log axes. Note that even as is, Q and
| C Bezier paths that are smooth on linear axes
| may not be smooth on log, and vice versa. no
| chained "polybezier" commands - specify the
| segment type for each one. On category axes,
| values are numbers scaled to the serial numbers
| of categories because using the categories
| themselves there would be no way to describe
| fractional positions On data axes: because
| space and T are both normal components of path
| strings, we can't use either to separate date
| from time parts. Therefore we'll use underscore
| for this purpose: 2015-02-21_13:45:56.789
| showlegend
| Determines whether or not this shape is shown
| in the legend.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| type
| Specifies the shape type to be drawn. If
| "line", a line is drawn from (`x0`,`y0`) to
| (`x1`,`y1`) with respect to the axes' sizing
| mode. If "circle", a circle is drawn from
| ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius
| (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2
| -`y0`)|) with respect to the axes' sizing mode.
| If "rect", a rectangle is drawn linking
| (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`),
| (`x0`,`y1`), (`x0`,`y0`) with respect to the
| axes' sizing mode. If "path", draw a custom SVG
| path using `path`. with respect to the axes'
| sizing mode.
| visible
| Determines whether or not this shape is
| visible. If "legendonly", the shape is not
| drawn, but can appear as a legend item
| (provided that the legend itself is visible).
| x0
| Sets the shape's starting x position. See
| `type` and `xsizemode` for more info.
| x0shift
| Shifts `x0` away from the center of the
| category when `xref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| x1
| Sets the shape's end x position. See `type` and
| `xsizemode` for more info.
| x1shift
| Shifts `x1` away from the center of the
| category when `xref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| xanchor
| Only relevant in conjunction with `xsizemode`
| set to "pixel". Specifies the anchor point on
| the x axis to which `x0`, `x1` and x
| coordinates within `path` are relative to. E.g.
| useful to attach a pixel sized shape to a
| certain data value. No effect when `xsizemode`
| not set to "pixel".
| xref
| Sets the shape's x coordinate axis. If set to a
| x axis id (e.g. "x" or "x2"), the `x` position
| refers to a x coordinate. If set to "paper",
| the `x` position refers to the distance from
| the left of the plotting area in normalized
| coordinates where 0 (1) corresponds to the left
| (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the left of the domain of that axis: e.g., *x2
| domain* refers to the domain of the second x
| axis and a x position of 0.5 refers to the
| point between the left and the right of the
| domain of the second x axis.
| xsizemode
| Sets the shapes's sizing mode along the x axis.
| If set to "scaled", `x0`, `x1` and x
| coordinates within `path` refer to data values
| on the x axis or a fraction of the plot area's
| width (`xref` set to "paper"). If set to
| "pixel", `xanchor` specifies the x position in
| terms of data or plot fraction but `x0`, `x1`
| and x coordinates within `path` are pixels
| relative to `xanchor`. This way, the shape can
| have a fixed width while maintaining a position
| relative to data or plot fraction.
| y0
| Sets the shape's starting y position. See
| `type` and `ysizemode` for more info.
| y0shift
| Shifts `y0` away from the center of the
| category when `yref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| y1
| Sets the shape's end y position. See `type` and
| `ysizemode` for more info.
| y1shift
| Shifts `y1` away from the center of the
| category when `yref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| yanchor
| Only relevant in conjunction with `ysizemode`
| set to "pixel". Specifies the anchor point on
| the y axis to which `y0`, `y1` and y
| coordinates within `path` are relative to. E.g.
| useful to attach a pixel sized shape to a
| certain data value. No effect when `ysizemode`
| not set to "pixel".
| yref
| Sets the shape's y coordinate axis. If set to a
| y axis id (e.g. "y" or "y2"), the `y` position
| refers to a y coordinate. If set to "paper",
| the `y` position refers to the distance from
| the bottom of the plotting area in normalized
| coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the bottom of the domain of that axis: e.g.,
| *y2 domain* refers to the domain of the second
| y axis and a y position of 0.5 refers to the
| point between the bottom and the top of the
| domain of the second y axis.
| ysizemode
| Sets the shapes's sizing mode along the y axis.
| If set to "scaled", `y0`, `y1` and y
| coordinates within `path` refer to data values
| on the y axis or a fraction of the plot area's
| height (`yref` set to "paper"). If set to
| "pixel", `yanchor` specifies the y position in
| terms of data or plot fraction but `y0`, `y1`
| and y coordinates within `path` are pixels
| relative to `yanchor`. This way, the shape can
| have a fixed height while maintaining a
| position relative to data or plot fraction.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Shape]
|
| showlegend
| Determines whether or not a legend is drawn. Default is `true`
| if there is a trace to show and any of these: a) Two or more
| traces would by default be shown in the legend. b) One pie
| trace is shown in the legend. c) One trace is explicitly given
| with `showlegend: true`.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets the default
| property values to use for elements of layout.sliders
|
| The 'sliderdefaults' property is an instance of Slider
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Slider`
| - A dict of string/value properties that will be passed
| to the Slider constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Slider
|
| sliders
| The 'sliders' property is a tuple of instances of
| Slider that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Slider
| - A list or tuple of dicts of string/value properties that
| will be passed to the Slider constructor
|
| Supported dict properties:
|
| active
| Determines which button (by index starting from
| 0) is considered active.
| activebgcolor
| Sets the background color of the slider grip
| while dragging.
| bgcolor
| Sets the background color of the slider.
| bordercolor
| Sets the color of the border enclosing the
| slider.
| borderwidth
| Sets the width (in px) of the border enclosing
| the slider.
| currentvalue
| :class:`plotly.graph_objects.layout.slider.Curr
| entvalue` instance or dict with compatible
| properties
| font
| Sets the font of the slider step labels.
| len
| Sets the length of the slider This measure
| excludes the padding of both ends. That is, the
| slider's length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this slider length is set in
| units of plot "fraction" or in *pixels. Use
| `len` to set the value.
| minorticklen
| Sets the length in pixels of minor step tick
| marks
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| pad
| Set the padding of the slider component along
| each side.
| steps
| A tuple of :class:`plotly.graph_objects.layout.
| slider.Step` instances or dicts with compatible
| properties
| stepdefaults
| When used in a template (as
| layout.template.layout.slider.stepdefaults),
| sets the default property values to use for
| elements of layout.slider.steps
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| tickcolor
| Sets the color of the border enclosing the
| slider.
| ticklen
| Sets the length in pixels of step tick marks
| tickwidth
| Sets the tick width (in px).
| transition
| :class:`plotly.graph_objects.layout.slider.Tran
| sition` instance or dict with compatible
| properties
| visible
| Determines whether or not the slider is
| visible.
| x
| Sets the x position (in normalized coordinates)
| of the slider.
| xanchor
| Sets the slider's horizontal position anchor.
| This anchor binds the `x` position to the
| "left", "center" or "right" of the range
| selector.
| y
| Sets the y position (in normalized coordinates)
| of the slider.
| yanchor
| Sets the slider's vertical position anchor This
| anchor binds the `y` position to the "top",
| "middle" or "bottom" of the range selector.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Slider]
|
| smith
| The 'smith' property is an instance of Smith
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Smith`
| - A dict of string/value properties that will be passed
| to the Smith constructor
|
| Supported dict properties:
|
| bgcolor
| Set the background color of the subplot
| domain
| :class:`plotly.graph_objects.layout.smith.Domai
| n` instance or dict with compatible properties
| imaginaryaxis
| :class:`plotly.graph_objects.layout.smith.Imagi
| naryaxis` instance or dict with compatible
| properties
| realaxis
| :class:`plotly.graph_objects.layout.smith.Reala
| xis` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.layout.Smith
|
| spikedistance
| Sets the default distance (in pixels) to look for data to draw
| spikelines to (-1 means no cutoff, 0 means no looking for
| data). As with hoverdistance, distance does not apply to area-
| like objects. In addition, some objects can be hovered on but
| will not generate spikelines, such as scatter fills.
|
| The 'spikedistance' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [-1, 9223372036854775807]
|
| Returns
| -------
| int
|
| sunburstcolorway
| Sets the default sunburst slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendsunburstcolors`.
|
| The 'sunburstcolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| template
| Default attributes to be applied to the plot. This should be a
| dict with format: `{'layout': layoutTemplate, 'data':
| {trace_type: [traceTemplate, ...], ...}}` where
| `layoutTemplate` is a dict matching the structure of
| `figure.layout` and `traceTemplate` is a dict matching the
| structure of the trace with type `trace_type` (e.g. 'scatter').
| Alternatively, this may be specified as an instance of
| plotly.graph_objs.layout.Template. Trace templates are applied
| cyclically to traces of each type. Container arrays (eg
| `annotations`) have special handling: An object ending in
| `defaults` (eg `annotationdefaults`) is applied to each array
| item. But if an item has a `templateitemname` key we look in
| the template array for an item with matching `name` and apply
| that instead. If no matching `name` is found we mark the item
| invisible. Any named template item not referenced is appended
| to the end of the array, so this can be used to add a watermark
| annotation or a logo image, for example. To omit one of these
| items on the plot, make an item with matching
| `templateitemname` and `visible: false`.
|
| The 'template' property is an instance of Template
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Template`
| - A dict of string/value properties that will be passed
| to the Template constructor
|
| Supported dict properties:
|
| data
| :class:`plotly.graph_objects.layout.template.Da
| ta` instance or dict with compatible properties
| layout
| :class:`plotly.graph_objects.Layout` instance
| or dict with compatible properties
|
| - The name of a registered template where current registered templates
| are stored in the plotly.io.templates configuration object. The names
| of all registered templates can be retrieved with:
| >>> import plotly.io as pio
| >>> list(pio.templates) # doctest: +ELLIPSIS
| ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]
|
| - A string containing multiple registered template names, joined on '+'
| characters (e.g. 'template1+template2'). In this case the resulting
| template is computed by merging together the collection of registered
| templates
|
| Returns
| -------
| plotly.graph_objs.layout.Template
|
| ternary
| The 'ternary' property is an instance of Ternary
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Ternary`
| - A dict of string/value properties that will be passed
| to the Ternary constructor
|
| Supported dict properties:
|
| aaxis
| :class:`plotly.graph_objects.layout.ternary.Aax
| is` instance or dict with compatible properties
| baxis
| :class:`plotly.graph_objects.layout.ternary.Bax
| is` instance or dict with compatible properties
| bgcolor
| Set the background color of the subplot
| caxis
| :class:`plotly.graph_objects.layout.ternary.Cax
| is` instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.ternary.Dom
| ain` instance or dict with compatible
| properties
| sum
| The number each triplet should sum to, and the
| maximum range of each axis
| uirevision
| Controls persistence of user-driven changes in
| axis `min` and `title`, if not overridden in
| the individual axes. Defaults to
| `layout.uirevision`.
|
| Returns
| -------
| plotly.graph_objs.layout.Ternary
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| automargin
| Determines whether the title can automatically
| push the figure margins. If `yref='paper'` then
| the margin will expand to ensure that the title
| doesn’t overlap with the edges of the
| container. If `yref='container'` then the
| margins will ensure that the title doesn’t
| overlap with the plot area, tick labels, and
| axis titles. If `automargin=true` and the
| margins need to be expanded, then y will be set
| to a default 1 and yanchor will be set to an
| appropriate default to ensure that minimal
| margin space is needed. Note that when
| `yref='paper'`, only 1 or 0 are allowed y
| values. Invalid values will be reset to the
| default 1.
| font
| Sets the title font. Note that the title's font
| used to be customized by the now deprecated
| `titlefont` attribute.
| pad
| Sets the padding of the title. Each padding
| value only applies when the corresponding
| `xanchor`/`yanchor` value is set accordingly.
| E.g. for left padding to take effect, `xanchor`
| must be set to "left". The same rule applies if
| `xanchor`/`yanchor` is determined
| automatically. Padding is muted if the
| respective anchor value is "middle*/*center".
| subtitle
| :class:`plotly.graph_objects.layout.title.Subti
| tle` instance or dict with compatible
| properties
| text
| Sets the plot's title. Note that before the
| existence of `title.text`, the title's contents
| used to be defined as the `title` attribute
| itself. This behavior has been deprecated.
| x
| Sets the x position with respect to `xref` in
| normalized coordinates from 0 (left) to 1
| (right).
| xanchor
| Sets the title's horizontal alignment with
| respect to its x position. "left" means that
| the title starts at x, "right" means that the
| title ends at x and "center" means that the
| title's center is at x. "auto" divides `xref`
| by three and calculates the `xanchor` value
| automatically based on the value of `x`.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` in
| normalized coordinates from 0 (bottom) to 1
| (top). "auto" places the baseline of the title
| onto the vertical center of the top margin.
| yanchor
| Sets the title's vertical alignment with
| respect to its y position. "top" means that the
| title's cap line is at y, "bottom" means that
| the title's baseline is at y and "middle" means
| that the title's midline is at y. "auto"
| divides `yref` by three and calculates the
| `yanchor` value automatically based on the
| value of `y`.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.layout.Title
|
| titlefont
| Deprecated: Please use layout.title.font instead. Sets the
| title font. Note that the title's font used to be customized by
| the now deprecated `titlefont` attribute.
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.title.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
|
| transition
| Sets transition options used during Plotly.react updates.
|
| The 'transition' property is an instance of Transition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Transition`
| - A dict of string/value properties that will be passed
| to the Transition constructor
|
| Supported dict properties:
|
| duration
| The duration of the transition, in
| milliseconds. If equal to zero, updates are
| synchronous.
| easing
| The easing function used for the transition
| ordering
| Determines whether the figure's layout or
| traces smoothly transitions during updates that
| make both traces and layout change.
|
| Returns
| -------
| plotly.graph_objs.layout.Transition
|
| treemapcolorway
| Sets the default treemap slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendtreemapcolors`.
|
| The 'treemapcolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| uirevision
| Used to allow user interactions with the plot to persist after
| `Plotly.react` calls that are unaware of these interactions. If
| `uirevision` is omitted, or if it is given and it changed from
| the previous `Plotly.react` call, the exact new figure is used.
| If `uirevision` is truthy and did NOT change, any attribute
| that has been affected by user interactions and did not receive
| a different value in the new figure will keep the interaction
| value. `layout.uirevision` attribute serves as the default for
| `uirevision` attributes in various sub-containers. For finer
| control you can set these sub-attributes directly. For example,
| if your app separately controls the data on the x and y axes
| you might set `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y data is changed,
| you can update `yaxis.uirevision=*quantity*` and the y axis
| range will reset but the x axis range will retain any user-
| driven zoom.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| uniformtext
| The 'uniformtext' property is an instance of Uniformtext
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Uniformtext`
| - A dict of string/value properties that will be passed
| to the Uniformtext constructor
|
| Supported dict properties:
|
| minsize
| Sets the minimum text size between traces of
| the same type.
| mode
| Determines how the font size for various text
| elements are uniformed between each trace type.
| If the computed text sizes were smaller than
| the minimum size defined by
| `uniformtext.minsize` using "hide" option hides
| the text; and using "show" option shows the
| text without further downscaling. Please note
| that if the size defined by `minsize` is
| greater than the font size defined by trace,
| then the `minsize` is used.
|
| Returns
| -------
| plotly.graph_objs.layout.Uniformtext
|
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults), sets the default
| property values to use for elements of layout.updatemenus
|
| The 'updatemenudefaults' property is an instance of Updatemenu
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Updatemenu`
| - A dict of string/value properties that will be passed
| to the Updatemenu constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Updatemenu
|
| updatemenus
| The 'updatemenus' property is a tuple of instances of
| Updatemenu that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Updatemenu
| - A list or tuple of dicts of string/value properties that
| will be passed to the Updatemenu constructor
|
| Supported dict properties:
|
| active
| Determines which button (by index starting from
| 0) is considered active.
| bgcolor
| Sets the background color of the update menu
| buttons.
| bordercolor
| Sets the color of the border enclosing the
| update menu.
| borderwidth
| Sets the width (in px) of the border enclosing
| the update menu.
| buttons
| A tuple of :class:`plotly.graph_objects.layout.
| updatemenu.Button` instances or dicts with
| compatible properties
| buttondefaults
| When used in a template (as layout.template.lay
| out.updatemenu.buttondefaults), sets the
| default property values to use for elements of
| layout.updatemenu.buttons
| direction
| Determines the direction in which the buttons
| are laid out, whether in a dropdown menu or a
| row/column of buttons. For `left` and `up`, the
| buttons will still appear in left-to-right or
| top-to-bottom order respectively.
| font
| Sets the font of the update menu button text.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| pad
| Sets the padding around the buttons or dropdown
| menu.
| showactive
| Highlights active dropdown item or active
| button if true.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| type
| Determines whether the buttons are accessible
| via a dropdown menu or whether the buttons are
| stacked horizontally or vertically
| visible
| Determines whether or not the update menu is
| visible.
| x
| Sets the x position (in normalized coordinates)
| of the update menu.
| xanchor
| Sets the update menu's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the range
| selector.
| y
| Sets the y position (in normalized coordinates)
| of the update menu.
| yanchor
| Sets the update menu's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the range
| selector.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Updatemenu]
|
| violingap
| Sets the gap (in plot fraction) between violins of adjacent
| location coordinates. Has no effect on traces that have "width"
| set.
|
| The 'violingap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| violingroupgap
| Sets the gap (in plot fraction) between violins of the same
| location coordinate. Has no effect on traces that have "width"
| set.
|
| The 'violingroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| violinmode
| Determines how violins at the same location coordinate are
| displayed on the graph. If "group", the violins are plotted
| next to one another centered around the shared location. If
| "overlay", the violins are plotted over one another, you might
| need to set "opacity" to see them multiple violins. Has no
| effect on traces that have "width" set.
|
| The 'violinmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| waterfallgap
| Sets the gap (in plot fraction) between bars of adjacent
| location coordinates.
|
| The 'waterfallgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of the same
| location coordinate.
|
| The 'waterfallgroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| waterfallmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "group", the bars are plotted next
| to one another centered around the shared location. With
| "overlay", the bars are plotted over one another, you might
| need to reduce "opacity" to see multiple bars.
|
| The 'waterfallmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| width
| Sets the plot's width (in px).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [10, inf]
|
| Returns
| -------
| int|float
|
| xaxis
| The 'xaxis' property is an instance of XAxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.XAxis`
| - A dict of string/value properties that will be passed
| to the XAxis constructor
|
| Supported dict properties:
|
| anchor
| If set to an opposite-letter axis id (e.g.
| `x2`, `y`), this axis is bound to the
| corresponding opposite-letter axis. If set to
| "free", this axis' position is determined by
| `position`.
| automargin
| Determines whether long tick labels
| automatically grow the figure margins.
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided and it has a value for both the lower
| and upper bound, `autorange` is set to False.
| Using "min" applies autorange only to set the
| minimum. Using "max" applies autorange only to
| set the maximum. Using *min reversed* applies
| autorange only to set the minimum on a reversed
| axis. Using *max reversed* applies autorange
| only to set the maximum on a reversed axis.
| Using "reversed" applies autorange on both ends
| and reverses the axis direction.
| autorangeoptions
| :class:`plotly.graph_objects.layout.xaxis.Autor
| angeoptions` instance or dict with compatible
| properties
| autotickangles
| When `tickangle` is set to "auto", it will be
| set to the first angle in this array that is
| large enough to prevent label overlap.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| calendar
| Sets the calendar system to use for `range` and
| `tick0` if this is a date axis. This does not
| set the calendar for interpreting data on this
| axis, that's specified in the trace or via the
| global `layout.calendar`
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`. Set
| `categoryorder` to *total ascending* or *total
| descending* if order should be determined by
| the numerical order of the values. Similarly,
| the order can be determined by the min, max,
| sum, mean, geometric mean or median of all the
| values.
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| constrain
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines how that
| happens: by increasing the "range", or by
| decreasing the "domain". Default is "domain"
| for axes containing image traces, "range"
| otherwise.
| constraintoward
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines which
| direction we push the originally specified plot
| area. Options are "left", "center" (default),
| and "right" for x axes, and "top", "middle"
| (default), and "bottom" for y axes.
| dividercolor
| Sets the color of the dividers Only has an
| effect on "multicategory" axes.
| dividerwidth
| Sets the width (in px) of the dividers Only has
| an effect on "multicategory" axes.
| domain
| Sets the domain of this axis (in plot
| fraction).
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the color of the grid lines.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the grid lines.
| hoverformat
| Sets the hover text formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| insiderange
| Could be used to set the desired inside range
| of this axis (excluding the labels) when
| `ticklabelposition` of the anchored axis has
| "inside". Not implemented for axes with `type`
| "log". This would be ignored when `range` is
| provided.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| layer
| Sets the layer on which this axis is displayed.
| If *above traces*, this axis is displayed above
| all the subplot's traces If *below traces*,
| this axis is displayed below all the subplot's
| traces, but above the grid lines. Useful when
| used together with scatter-like traces with
| `cliponaxis` set to False to show markers
| and/or text nodes above this axis.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| matches
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis will match the range of the
| corresponding axis in data-coordinates space.
| Moreover, matching axes share auto-range
| values, category lists and histogram auto-bins.
| Note that setting axes simultaneously in both a
| `scaleanchor` and a `matches` constraint is
| currently forbidden. Moreover, note that
| matching axes must have the same `type`.
| maxallowed
| Determines the maximum range of this axis.
| minallowed
| Determines the minimum range of this axis.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| minor
| :class:`plotly.graph_objects.layout.xaxis.Minor
| ` instance or dict with compatible properties
| mirror
| Determines if the axis lines or/and ticks are
| mirrored to the opposite side of the plotting
| area. If True, the axis lines are mirrored. If
| "ticks", the axis lines and ticks are mirrored.
| If False, mirroring is disable. If "all", axis
| lines are mirrored on all shared-axes subplots.
| If "allticks", axis lines and ticks are
| mirrored on all shared-axes subplots.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| overlaying
| If set a same-letter axis id, this axis is
| overlaid on top of the corresponding same-
| letter axis, with traces and axes visible for
| both axes. If False, this axis does not overlay
| any same-letter axes. In this case, for axes
| with overlapping domains only the highest-
| numbered axis will be visible.
| position
| Sets the position of this axis in the plotting
| space (in normalized coordinates). Only has an
| effect if `anchor` is set to "free".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears. Leaving either or both
| elements `null` impacts the default
| `autorange`.
| rangebreaks
| A tuple of :class:`plotly.graph_objects.layout.
| xaxis.Rangebreak` instances or dicts with
| compatible properties
| rangebreakdefaults
| When used in a template (as layout.template.lay
| out.xaxis.rangebreakdefaults), sets the default
| property values to use for elements of
| layout.xaxis.rangebreaks
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data. Applies
| only to linear axes.
| rangeselector
| :class:`plotly.graph_objects.layout.xaxis.Range
| selector` instance or dict with compatible
| properties
| rangeslider
| :class:`plotly.graph_objects.layout.xaxis.Range
| slider` instance or dict with compatible
| properties
| scaleanchor
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis changes together with the
| range of the corresponding axis such that the
| scale of pixels per unit is in a constant
| ratio. Both axes are still zoomable, but when
| you zoom one, the other will zoom the same
| amount, keeping a fixed midpoint. `constrain`
| and `constraintoward` determine how we enforce
| the constraint. You can chain these, ie `yaxis:
| {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}`
| but you can only link axes of the same `type`.
| The linked axis can have the opposite letter
| (to constrain the aspect ratio) or the same
| letter (to match scales across subplots). Loops
| (`yaxis: {scaleanchor: *x*}, xaxis:
| {scaleanchor: *y*}` or longer) are redundant
| and the last constraint encountered will be
| ignored to avoid possible inconsistent
| constraints via `scaleratio`. Note that setting
| axes simultaneously in both a `scaleanchor` and
| a `matches` constraint is currently forbidden.
| Setting `false` allows to remove a default
| constraint (occasionally, you may need to
| prevent a default `scaleanchor` constraint from
| being applied, eg. when having an image trace
| `yaxis: {scaleanchor: "x"}` is set
| automatically in order for pixels to be
| rendered as squares, setting `yaxis:
| {scaleanchor: false}` allows to remove the
| constraint).
| scaleratio
| If this axis is linked to another by
| `scaleanchor`, this determines the pixel to
| unit scale ratio. For example, if this value is
| 10, then every unit on this axis spans 10 times
| the number of pixels as a unit on the linked
| axis. Use this for example to create an
| elevation profile where the vertical scale is
| exaggerated a fixed amount with respect to the
| horizontal.
| separatethousands
| If "true", even 4-digit integers are separated
| showdividers
| Determines whether or not a dividers are drawn
| between the category levels of this axis. Only
| has an effect on "multicategory" axes.
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showspikes
| Determines whether or not spikes (aka
| droplines) are drawn for this axis. Note: This
| only takes affect when hovermode = closest
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| side
| Determines whether a x (y) axis is positioned
| at the "bottom" ("left") or "top" ("right") of
| the plotting area.
| spikecolor
| Sets the spike color. If undefined, will use
| the series color
| spikedash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| spikemode
| Determines the drawing mode for the spike line
| If "toaxis", the line is drawn from the data
| point to the axis the series is plotted on. If
| "across", the line is drawn across the entire
| plot area, and supercedes "toaxis". If
| "marker", then a marker dot is drawn on the
| axis the series is plotted on
| spikesnap
| Determines whether spikelines are stuck to the
| cursor or to the closest datapoints.
| spikethickness
| Sets the width (in px) of the zero line.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.layout.
| xaxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.lay
| out.xaxis.tickformatstopdefaults), sets the
| default property values to use for elements of
| layout.xaxis.tickformatstops
| ticklabelindex
| Only for axes with `type` "date" or "linear".
| Instead of drawing the major tick label, draw
| the label for the minor tick that is n
| positions away from the major tick. E.g. to
| always draw the label for the minor tick before
| each major tick, choose `ticklabelindex` -1.
| This is useful for date axes with
| `ticklabelmode` "period" if you want to label
| the period that ends with each major tick
| instead of the period that begins there.
| ticklabelindexsrc
| Sets the source reference on Chart Studio Cloud
| for `ticklabelindex`.
| ticklabelmode
| Determines where tick labels are drawn with
| respect to their corresponding ticks and grid
| lines. Only has an effect for axes of `type`
| "date" When set to "period", tick labels are
| drawn in the middle of the period between
| ticks.
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. Otherwise on
| "category" and "multicategory" axes the default
| is "allow". In other cases the default is *hide
| past div*.
| ticklabelposition
| Determines where tick labels are drawn with
| respect to the axis Please note that top or
| bottom has no effect on x axes or when
| `ticklabelmode` is set to "period". Similarly
| left or right has no effect on y axes or when
| `ticklabelmode` is set to "period". Has no
| effect on "multicategory" axes or when
| `tickson` is set to "boundaries". When used on
| axes linked by `matches` or `scaleanchor`, no
| extra padding for inside labels would be added
| by autorange, so that the scales could match.
| ticklabelshift
| Shifts the tick labels by the specified number
| of pixels in parallel to the axis. Positive
| values move the labels in the positive
| direction of the axis.
| ticklabelstandoff
| Sets the standoff distance (in px) between the
| axis tick labels and their default position. A
| positive `ticklabelstandoff` moves the labels
| farther away from the plot area if
| `ticklabelposition` is "outside", and deeper
| into the plot area if `ticklabelposition` is
| "inside". A negative `ticklabelstandoff` works
| in the opposite direction, moving outside ticks
| towards the plot area and inside ticks towards
| the outside. If the negative value is large
| enough, inside ticks can even end up outside
| and vice versa.
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided). If "sync", the number of ticks will
| sync with the overlayed axis set by
| `overlaying` property.
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| tickson
| Determines where ticks and grid lines are drawn
| with respect to their corresponding tick
| labels. Only has an effect for axes of `type`
| "category" or "multicategory". When set to
| "boundaries", ticks and grid lines are drawn
| half a category to the left/bottom of labels.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.layout.xaxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.xaxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be customized by the
| now deprecated `titlefont` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
| uirevision
| Controls persistence of user-driven changes in
| axis `range`, `autorange`, and `title` if in
| `editable: true` configuration. Defaults to
| `layout.uirevision`.
| visible
| A single toggle to hide the axis while
| preserving interaction like dragging. Default
| is true when a cheater plot is present on the
| axis, otherwise false
| zeroline
| Determines whether or not a line is drawn at
| along the 0 value of this axis. If True, the
| zero line is drawn on top of the grid lines.
| zerolinecolor
| Sets the line color of the zero line.
| zerolinewidth
| Sets the width (in px) of the zero line.
|
| Returns
| -------
| plotly.graph_objs.layout.XAxis
|
| yaxis
| The 'yaxis' property is an instance of YAxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.YAxis`
| - A dict of string/value properties that will be passed
| to the YAxis constructor
|
| Supported dict properties:
|
| anchor
| If set to an opposite-letter axis id (e.g.
| `x2`, `y`), this axis is bound to the
| corresponding opposite-letter axis. If set to
| "free", this axis' position is determined by
| `position`.
| automargin
| Determines whether long tick labels
| automatically grow the figure margins.
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided and it has a value for both the lower
| and upper bound, `autorange` is set to False.
| Using "min" applies autorange only to set the
| minimum. Using "max" applies autorange only to
| set the maximum. Using *min reversed* applies
| autorange only to set the minimum on a reversed
| axis. Using *max reversed* applies autorange
| only to set the maximum on a reversed axis.
| Using "reversed" applies autorange on both ends
| and reverses the axis direction.
| autorangeoptions
| :class:`plotly.graph_objects.layout.yaxis.Autor
| angeoptions` instance or dict with compatible
| properties
| autoshift
| Automatically reposition the axis to avoid
| overlap with other axes with the same
| `overlaying` value. This repositioning will
| account for any `shift` amount applied to other
| axes on the same side with `autoshift` is set
| to true. Only has an effect if `anchor` is set
| to "free".
| autotickangles
| When `tickangle` is set to "auto", it will be
| set to the first angle in this array that is
| large enough to prevent label overlap.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| calendar
| Sets the calendar system to use for `range` and
| `tick0` if this is a date axis. This does not
| set the calendar for interpreting data on this
| axis, that's specified in the trace or via the
| global `layout.calendar`
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`. Set
| `categoryorder` to *total ascending* or *total
| descending* if order should be determined by
| the numerical order of the values. Similarly,
| the order can be determined by the min, max,
| sum, mean, geometric mean or median of all the
| values.
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| constrain
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines how that
| happens: by increasing the "range", or by
| decreasing the "domain". Default is "domain"
| for axes containing image traces, "range"
| otherwise.
| constraintoward
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines which
| direction we push the originally specified plot
| area. Options are "left", "center" (default),
| and "right" for x axes, and "top", "middle"
| (default), and "bottom" for y axes.
| dividercolor
| Sets the color of the dividers Only has an
| effect on "multicategory" axes.
| dividerwidth
| Sets the width (in px) of the dividers Only has
| an effect on "multicategory" axes.
| domain
| Sets the domain of this axis (in plot
| fraction).
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the color of the grid lines.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the grid lines.
| hoverformat
| Sets the hover text formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| insiderange
| Could be used to set the desired inside range
| of this axis (excluding the labels) when
| `ticklabelposition` of the anchored axis has
| "inside". Not implemented for axes with `type`
| "log". This would be ignored when `range` is
| provided.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| layer
| Sets the layer on which this axis is displayed.
| If *above traces*, this axis is displayed above
| all the subplot's traces If *below traces*,
| this axis is displayed below all the subplot's
| traces, but above the grid lines. Useful when
| used together with scatter-like traces with
| `cliponaxis` set to False to show markers
| and/or text nodes above this axis.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| matches
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis will match the range of the
| corresponding axis in data-coordinates space.
| Moreover, matching axes share auto-range
| values, category lists and histogram auto-bins.
| Note that setting axes simultaneously in both a
| `scaleanchor` and a `matches` constraint is
| currently forbidden. Moreover, note that
| matching axes must have the same `type`.
| maxallowed
| Determines the maximum range of this axis.
| minallowed
| Determines the minimum range of this axis.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| minor
| :class:`plotly.graph_objects.layout.yaxis.Minor
| ` instance or dict with compatible properties
| mirror
| Determines if the axis lines or/and ticks are
| mirrored to the opposite side of the plotting
| area. If True, the axis lines are mirrored. If
| "ticks", the axis lines and ticks are mirrored.
| If False, mirroring is disable. If "all", axis
| lines are mirrored on all shared-axes subplots.
| If "allticks", axis lines and ticks are
| mirrored on all shared-axes subplots.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| overlaying
| If set a same-letter axis id, this axis is
| overlaid on top of the corresponding same-
| letter axis, with traces and axes visible for
| both axes. If False, this axis does not overlay
| any same-letter axes. In this case, for axes
| with overlapping domains only the highest-
| numbered axis will be visible.
| position
| Sets the position of this axis in the plotting
| space (in normalized coordinates). Only has an
| effect if `anchor` is set to "free".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears. Leaving either or both
| elements `null` impacts the default
| `autorange`.
| rangebreaks
| A tuple of :class:`plotly.graph_objects.layout.
| yaxis.Rangebreak` instances or dicts with
| compatible properties
| rangebreakdefaults
| When used in a template (as layout.template.lay
| out.yaxis.rangebreakdefaults), sets the default
| property values to use for elements of
| layout.yaxis.rangebreaks
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data. Applies
| only to linear axes.
| scaleanchor
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis changes together with the
| range of the corresponding axis such that the
| scale of pixels per unit is in a constant
| ratio. Both axes are still zoomable, but when
| you zoom one, the other will zoom the same
| amount, keeping a fixed midpoint. `constrain`
| and `constraintoward` determine how we enforce
| the constraint. You can chain these, ie `yaxis:
| {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}`
| but you can only link axes of the same `type`.
| The linked axis can have the opposite letter
| (to constrain the aspect ratio) or the same
| letter (to match scales across subplots). Loops
| (`yaxis: {scaleanchor: *x*}, xaxis:
| {scaleanchor: *y*}` or longer) are redundant
| and the last constraint encountered will be
| ignored to avoid possible inconsistent
| constraints via `scaleratio`. Note that setting
| axes simultaneously in both a `scaleanchor` and
| a `matches` constraint is currently forbidden.
| Setting `false` allows to remove a default
| constraint (occasionally, you may need to
| prevent a default `scaleanchor` constraint from
| being applied, eg. when having an image trace
| `yaxis: {scaleanchor: "x"}` is set
| automatically in order for pixels to be
| rendered as squares, setting `yaxis:
| {scaleanchor: false}` allows to remove the
| constraint).
| scaleratio
| If this axis is linked to another by
| `scaleanchor`, this determines the pixel to
| unit scale ratio. For example, if this value is
| 10, then every unit on this axis spans 10 times
| the number of pixels as a unit on the linked
| axis. Use this for example to create an
| elevation profile where the vertical scale is
| exaggerated a fixed amount with respect to the
| horizontal.
| separatethousands
| If "true", even 4-digit integers are separated
| shift
| Moves the axis a given number of pixels from
| where it would have been otherwise. Accepts
| both positive and negative values, which will
| shift the axis either right or left,
| respectively. If `autoshift` is set to true,
| then this defaults to a padding of -3 if `side`
| is set to "left". and defaults to +3 if `side`
| is set to "right". Defaults to 0 if `autoshift`
| is set to false. Only has an effect if `anchor`
| is set to "free".
| showdividers
| Determines whether or not a dividers are drawn
| between the category levels of this axis. Only
| has an effect on "multicategory" axes.
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showspikes
| Determines whether or not spikes (aka
| droplines) are drawn for this axis. Note: This
| only takes affect when hovermode = closest
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| side
| Determines whether a x (y) axis is positioned
| at the "bottom" ("left") or "top" ("right") of
| the plotting area.
| spikecolor
| Sets the spike color. If undefined, will use
| the series color
| spikedash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| spikemode
| Determines the drawing mode for the spike line
| If "toaxis", the line is drawn from the data
| point to the axis the series is plotted on. If
| "across", the line is drawn across the entire
| plot area, and supercedes "toaxis". If
| "marker", then a marker dot is drawn on the
| axis the series is plotted on
| spikesnap
| Determines whether spikelines are stuck to the
| cursor or to the closest datapoints.
| spikethickness
| Sets the width (in px) of the zero line.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.layout.
| yaxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.lay
| out.yaxis.tickformatstopdefaults), sets the
| default property values to use for elements of
| layout.yaxis.tickformatstops
| ticklabelindex
| Only for axes with `type` "date" or "linear".
| Instead of drawing the major tick label, draw
| the label for the minor tick that is n
| positions away from the major tick. E.g. to
| always draw the label for the minor tick before
| each major tick, choose `ticklabelindex` -1.
| This is useful for date axes with
| `ticklabelmode` "period" if you want to label
| the period that ends with each major tick
| instead of the period that begins there.
| ticklabelindexsrc
| Sets the source reference on Chart Studio Cloud
| for `ticklabelindex`.
| ticklabelmode
| Determines where tick labels are drawn with
| respect to their corresponding ticks and grid
| lines. Only has an effect for axes of `type`
| "date" When set to "period", tick labels are
| drawn in the middle of the period between
| ticks.
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. Otherwise on
| "category" and "multicategory" axes the default
| is "allow". In other cases the default is *hide
| past div*.
| ticklabelposition
| Determines where tick labels are drawn with
| respect to the axis Please note that top or
| bottom has no effect on x axes or when
| `ticklabelmode` is set to "period". Similarly
| left or right has no effect on y axes or when
| `ticklabelmode` is set to "period". Has no
| effect on "multicategory" axes or when
| `tickson` is set to "boundaries". When used on
| axes linked by `matches` or `scaleanchor`, no
| extra padding for inside labels would be added
| by autorange, so that the scales could match.
| ticklabelshift
| Shifts the tick labels by the specified number
| of pixels in parallel to the axis. Positive
| values move the labels in the positive
| direction of the axis.
| ticklabelstandoff
| Sets the standoff distance (in px) between the
| axis tick labels and their default position. A
| positive `ticklabelstandoff` moves the labels
| farther away from the plot area if
| `ticklabelposition` is "outside", and deeper
| into the plot area if `ticklabelposition` is
| "inside". A negative `ticklabelstandoff` works
| in the opposite direction, moving outside ticks
| towards the plot area and inside ticks towards
| the outside. If the negative value is large
| enough, inside ticks can even end up outside
| and vice versa.
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided). If "sync", the number of ticks will
| sync with the overlayed axis set by
| `overlaying` property.
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| tickson
| Determines where ticks and grid lines are drawn
| with respect to their corresponding tick
| labels. Only has an effect for axes of `type`
| "category" or "multicategory". When set to
| "boundaries", ticks and grid lines are drawn
| half a category to the left/bottom of labels.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.layout.yaxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.yaxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be customized by the
| now deprecated `titlefont` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
| uirevision
| Controls persistence of user-driven changes in
| axis `range`, `autorange`, and `title` if in
| `editable: true` configuration. Defaults to
| `layout.uirevision`.
| visible
| A single toggle to hide the axis while
| preserving interaction like dragging. Default
| is true when a cheater plot is present on the
| axis, otherwise false
| zeroline
| Determines whether or not a line is drawn at
| along the 0 value of this axis. If True, the
| zero line is drawn on top of the grid lines.
| zerolinecolor
| Sets the line color of the zero line.
| zerolinewidth
| Sets the width (in px) of the zero line.
|
| Returns
| -------
| plotly.graph_objs.layout.YAxis
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| re = <module 're' from 'C:\\Users\\Youse\\AppData\\Lo...ograms\\Python...
| Support for regular expressions (RE).
|
| This module provides regular expression matching operations similar to
| those found in Perl. It supports both 8-bit and Unicode strings; both
| the pattern and the strings being processed can contain null bytes and
| characters outside the US ASCII range.
|
| Regular expressions can contain both special and ordinary characters.
| Most ordinary characters, like "A", "a", or "0", are the simplest
| regular expressions; they simply match themselves. You can
| concatenate ordinary characters, so last matches the string 'last'.
|
| The special characters are:
| "." Matches any character except a newline.
| "^" Matches the start of the string.
| "$" Matches the end of the string or just before the newline at
| the end of the string.
| "*" Matches 0 or more (greedy) repetitions of the preceding RE.
| Greedy means that it will match as many repetitions as possible.
| "+" Matches 1 or more (greedy) repetitions of the preceding RE.
| "?" Matches 0 or 1 (greedy) of the preceding RE.
| *?,+?,?? Non-greedy versions of the previous three special characters.
| {m,n} Matches from m to n repetitions of the preceding RE.
| {m,n}? Non-greedy version of the above.
| "\\" Either escapes special characters or signals a special sequence.
| [] Indicates a set of characters.
| A "^" as the first character indicates a complementing set.
| "|" A|B, creates an RE that will match either A or B.
| (...) Matches the RE inside the parentheses.
| The contents can be retrieved or matched later in the string.
| (?aiLmsux) The letters set the corresponding flags defined below.
| (?:...) Non-grouping version of regular parentheses.
| (?P<name>...) The substring matched by the group is accessible by name.
| (?P=name) Matches the text matched earlier by the group named name.
| (?#...) A comment; ignored.
| (?=...) Matches if ... matches next, but doesn't consume the string.
| (?!...) Matches if ... doesn't match next.
| (?<=...) Matches if preceded by ... (must be fixed length).
| (?<!...) Matches if not preceded by ... (must be fixed length).
| (?(id/name)yes|no) Matches yes pattern if the group with id/name matched,
| the (optional) no pattern otherwise.
|
| The special sequences consist of "\\" and a character from the list
| below. If the ordinary character is not on the list, then the
| resulting RE will match the second character.
| \number Matches the contents of the group of the same number.
| \A Matches only at the start of the string.
| \Z Matches only at the end of the string.
| \b Matches the empty string, but only at the start or end of a word.
| \B Matches the empty string, but not at the start or end of a word.
| \d Matches any decimal digit; equivalent to the set [0-9] in
| bytes patterns or string patterns with the ASCII flag.
| In string patterns without the ASCII flag, it will match the whole
| range of Unicode digits.
| \D Matches any non-digit character; equivalent to [^\d].
| \s Matches any whitespace character; equivalent to [ \t\n\r\f\v] in
| bytes patterns or string patterns with the ASCII flag.
| In string patterns without the ASCII flag, it will match the whole
| range of Unicode whitespace characters.
| \S Matches any non-whitespace character; equivalent to [^\s].
| \w Matches any alphanumeric character; equivalent to [a-zA-Z0-9_]
| in bytes patterns or string patterns with the ASCII flag.
| In string patterns without the ASCII flag, it will match the
| range of Unicode alphanumeric characters (letters plus digits
| plus underscore).
| With LOCALE, it will match the set [0-9_] plus characters defined
| as letters for the current locale.
| \W Matches the complement of \w.
| \\ Matches a literal backslash.
|
| This module exports the following functions:
| match Match a regular expression pattern to the beginning of a string.
| fullmatch Match a regular expression pattern to all of a string.
| search Search a string for the presence of a pattern.
| sub Substitute occurrences of a pattern found in a string.
| subn Same as sub, but also return the number of substitutions made.
| split Split a string by the occurrences of a pattern.
| findall Find all occurrences of a pattern in a string.
| finditer Return an iterator yielding a Match object for each match.
| compile Compile a pattern into a Pattern object.
| purge Clear the regular expression cache.
| escape Backslash all non-alphanumerics in a string.
|
| Each function other than purge and escape can take an optional 'flags' argument
| consisting of one or more of the following module constants, joined by "|".
| A, L, and U are mutually exclusive.
| A ASCII For string patterns, make \w, \W, \b, \B, \d, \D
| match the corresponding ASCII character categories
| (rather than the whole Unicode categories, which is the
| default).
| For bytes patterns, this flag is the only available
| behaviour and needn't be specified.
| I IGNORECASE Perform case-insensitive matching.
| L LOCALE Make \w, \W, \b, \B, dependent on the current locale.
| M MULTILINE "^" matches the beginning of lines (after a newline)
| as well as the string.
| "$" matches the end of lines (before a newline) as well
| as the end of the string.
| S DOTALL "." matches any character at all, including the newline.
| X VERBOSE Ignore whitespace and comments for nicer looking RE's.
| U UNICODE For compatibility only. Ignored for string patterns (it
| is the default), and forbidden for bytes patterns.
|
| This module also defines an exception 'error'.
|
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseLayoutType:
|
| __contains__(self, prop)
| Custom __contains__ that handles dynamic subplot properties
|
| __dir__(self)
| Custom __dir__ that handles dynamic subplot properties
|
| __getattr__(self, prop)
| Custom __getattr__ that handles dynamic subplot properties
|
| __getitem__(self, prop)
| Custom __getitem__ that handles dynamic subplot properties
|
| __setattr__(self, prop, value)
| Custom __setattr__ that handles dynamic subplot properties
|
| __setitem__(self, prop, value)
| Custom __setitem__ that handles dynamic subplot properties
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object representation when displayed in the
| terminal/notebook
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Legend(builtins.dict)
| Legend(*args, **kwargs)
|
| plotly.graph_objs.Legend is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Legend
|
| Method resolution order:
| Legend
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Legend is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Legend
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Line(builtins.dict)
| Line(*args, **kwargs)
|
| plotly.graph_objs.Line is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Line
| - plotly.graph_objs.layout.shape.Line
| - etc.
|
| Method resolution order:
| Line
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Line is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Line
| - plotly.graph_objs.layout.shape.Line
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Margin(builtins.dict)
| Margin(*args, **kwargs)
|
| plotly.graph_objs.Margin is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Margin
|
| Method resolution order:
| Margin
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Margin is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Margin
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Marker(builtins.dict)
| Marker(*args, **kwargs)
|
| plotly.graph_objs.Marker is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Marker
| - plotly.graph_objs.histogram.selected.Marker
| - etc.
|
| Method resolution order:
| Marker
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Marker is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Marker
| - plotly.graph_objs.histogram.selected.Marker
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Mesh3d(plotly.basedatatypes.BaseTraceType)
| Mesh3d(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Mesh3d
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Mesh3d object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Mesh3d`
| alphahull
| Determines how the mesh surface triangles are derived
| from the set of vertices (points) represented by the
| `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays
| are not supplied. For general use of `mesh3d` it is
| preferred that `i`, `j`, `k` are supplied. If "-1",
| Delaunay triangulation is used, which is mainly
| suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In
| case the `delaunayaxis` intersects the mesh surface at
| more than one point it will result triangles that are
| very long in the dimension of `delaunayaxis`. If ">0",
| the alpha-shape algorithm is used. In this case, the
| positive `alphahull` value signals the use of the
| alpha-shape algorithm, _and_ its value acts as the
| parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or
| if the intention is to enclose the `x`, `y` and `z`
| point set into a convex hull.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `intensity`) or
| the bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `intensity`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmax`
| must be set as well.
| color
| Sets the color of the whole mesh
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.mesh3d.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.mesh3d.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is
| perpendicular to the surface of the Delaunay
| triangulation. It has an effect if `i`, `j`, `k` are
| not provided and `alphahull` is set to indicate
| Delaunay triangulation.
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.mesh3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| i
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "first" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `i[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `i` represents a point in space, which
| is the first vertex of a triangle.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| intensity
| Sets the intensity values for vertices or cells as
| defined by `intensitymode`. It can be used for plotting
| fields on meshes.
| intensitymode
| Determines the source of `intensity` values.
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
| isrc
| Sets the source reference on Chart Studio Cloud for
| `i`.
| j
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "second" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `j[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `j` represents a point in space, which
| is the second vertex of a triangle.
| jsrc
| Sets the source reference on Chart Studio Cloud for
| `j`.
| k
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "third" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `k[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `k` represents a point in space, which
| is the third vertex of a triangle.
| ksrc
| Sets the source reference on Chart Studio Cloud for
| `k`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.mesh3d.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.mesh3d.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.mesh3d.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.mesh3d.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| vertexcolor
| Sets the color of each vertex Overrides "color". While
| Red, green and blue colors are in the range of 0 and
| 255; in the case of having vertex color data in RGBA
| format, the alpha color should be normalized to be
| between 0 and 1.
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Mesh3d
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alphahull
| Determines how the mesh surface triangles are derived from the
| set of vertices (points) represented by the `x`, `y` and `z`
| arrays, if the `i`, `j`, `k` arrays are not supplied. For
| general use of `mesh3d` it is preferred that `i`, `j`, `k` are
| supplied. If "-1", Delaunay triangulation is used, which is
| mainly suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In case the
| `delaunayaxis` intersects the mesh surface at more than one
| point it will result triangles that are very long in the
| dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm
| is used. In this case, the positive `alphahull` value signals
| the use of the alpha-shape algorithm, _and_ its value acts as
| the parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or if the
| intention is to enclose the `x`, `y` and `z` point set into a
| convex hull.
|
| The 'alphahull' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here `intensity`) or the bounds set
| in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as `intensity` and if set, `cmin` must be set as
| well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as `intensity`. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as `intensity` and if set, `cmax` must be set as
| well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| color
| Sets the color of the whole mesh
|
| The 'color' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
| - A number that will be interpreted as a color
| according to mesh3d.colorscale
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.mesh3d.
| colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.mesh3d.colorbar.tickformatstopdefaults), sets
| the default property values to use for elements
| of mesh3d.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.mesh3d.colorbar.Ti
| tle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| mesh3d.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| mesh3d.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contour
| The 'contour' property is an instance of Contour
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Contour`
| - A dict of string/value properties that will be passed
| to the Contour constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour lines.
| show
| Sets whether or not dynamic contours are shown
| on hover
| width
| Sets the width of the contour lines.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Contour
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is perpendicular
| to the surface of the Delaunay triangulation. It has an effect
| if `i`, `j`, `k` are not provided and `alphahull` is set to
| indicate Delaunay triangulation.
|
| The 'delaunayaxis' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['x', 'y', 'z']
|
| Returns
| -------
| Any
|
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
|
| The 'facecolor' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
|
| The 'facecolorsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| flatshading
| Determines whether or not normal smoothing is applied to the
| meshes, creating meshes with an angular, low-poly look via flat
| reflections.
|
| The 'flatshading' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| i
| A vector of vertex indices, i.e. integer values between 0 and
| the length of the vertex vectors, representing the "first"
| vertex of a triangle. For example, `{i[m], j[m], k[m]}`
| together represent face m (triangle m) in the mesh, where `i[m]
| = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex
| arrays. Therefore, each element in `i` represents a point in
| space, which is the first vertex of a triangle.
|
| The 'i' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| intensity
| Sets the intensity values for vertices or cells as defined by
| `intensitymode`. It can be used for plotting fields on meshes.
|
| The 'intensity' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| intensitymode
| Determines the source of `intensity` values.
|
| The 'intensitymode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['vertex', 'cell']
|
| Returns
| -------
| Any
|
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
|
| The 'intensitysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| isrc
| Sets the source reference on Chart Studio Cloud for `i`.
|
| The 'isrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| j
| A vector of vertex indices, i.e. integer values between 0 and
| the length of the vertex vectors, representing the "second"
| vertex of a triangle. For example, `{i[m], j[m], k[m]}`
| together represent face m (triangle m) in the mesh, where `j[m]
| = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex
| arrays. Therefore, each element in `j` represents a point in
| space, which is the second vertex of a triangle.
|
| The 'j' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| jsrc
| Sets the source reference on Chart Studio Cloud for `j`.
|
| The 'jsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| k
| A vector of vertex indices, i.e. integer values between 0 and
| the length of the vertex vectors, representing the "third"
| vertex of a triangle. For example, `{i[m], j[m], k[m]}`
| together represent face m (triangle m) in the mesh, where `k[m]
| = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex
| arrays. Therefore, each element in `k` represents a point in
| space, which is the third vertex of a triangle.
|
| The 'k' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ksrc
| Sets the source reference on Chart Studio Cloud for `k`.
|
| The 'ksrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Stream
|
| text
| Sets the text elements associated with the vertices. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| vertexcolor
| Sets the color of each vertex Overrides "color". While Red,
| green and blue colors are in the range of 0 and 255; in the
| case of having vertex color data in RGBA format, the alpha
| color should be normalized to be between 0 and 1.
|
| The 'vertexcolor' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
|
| The 'vertexcolorsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the X coordinates of the vertices. The nth element of
| vectors `x`, `y` and `z` jointly represent the X, Y and Z
| coordinates of the nth vertex.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the Y coordinates of the vertices. The nth element of
| vectors `x`, `y` and `z` jointly represent the X, Y and Z
| coordinates of the nth vertex.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the Z coordinates of the vertices. The nth element of
| vectors `x`, `y` and `z` jointly represent the X, Y and Z
| coordinates of the nth vertex.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zcalendar
| Sets the calendar system to use with `z` date data.
|
| The 'zcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Ohlc(plotly.basedatatypes.BaseTraceType)
| Ohlc(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
|
| Method resolution order:
| Ohlc
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
| Construct a new Ohlc object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Ohlc`
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.ohlc.Decreasing` instance
| or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.ohlc.Hoverlabel` instance
| or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.ohlc.Increasing` instance
| or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.ohlc.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.ohlc.Line` instance or
| dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.ohlc.Stream` instance or
| dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| tickwidth
| Sets the width of the open/close tick marks relative to
| the "x" minimal interval.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Ohlc
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| close
| Sets the close values.
|
| The 'close' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| closesrc
| Sets the source reference on Chart Studio Cloud for `close`.
|
| The 'closesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| decreasing
| The 'decreasing' property is an instance of Decreasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Decreasing`
| - A dict of string/value properties that will be passed
| to the Decreasing constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.ohlc.decreasing.Li
| ne` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.ohlc.Decreasing
|
| high
| Sets the high values.
|
| The 'high' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| highsrc
| Sets the source reference on Chart Studio Cloud for `high`.
|
| The 'highsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
| split
| Show hover information (open, close, high, low)
| in separate labels.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Hoverlabel
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| increasing
| The 'increasing' property is an instance of Increasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Increasing`
| - A dict of string/value properties that will be passed
| to the Increasing constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.ohlc.increasing.Li
| ne` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.ohlc.Increasing
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| Note that this style setting can also be set
| per direction via `increasing.line.dash` and
| `decreasing.line.dash`.
| width
| [object Object] Note that this style setting
| can also be set per direction via
| `increasing.line.width` and
| `decreasing.line.width`.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Line
|
| low
| Sets the low values.
|
| The 'low' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lowsrc
| Sets the source reference on Chart Studio Cloud for `low`.
|
| The 'lowsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| open
| Sets the open values.
|
| The 'open' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| opensrc
| Sets the source reference on Chart Studio Cloud for `open`.
|
| The 'opensrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Stream
|
| text
| Sets hover text elements associated with each sample point. If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| this trace's sample points.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| tickwidth
| Sets the width of the open/close tick marks relative to the "x"
| minimal interval.
|
| The 'tickwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 0.5]
|
| Returns
| -------
| int|float
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates. If absent, linear coordinate will be
| generated.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Parcats(plotly.basedatatypes.BaseTraceType)
| Parcats(arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)
|
| Method resolution order:
| Parcats
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)
| Construct a new Parcats object
|
| Parallel categories diagram for multidimensional categorical
| data.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Parcats`
| arrangement
| Sets the drag interaction mode for categories and
| dimensions. If `perpendicular`, the categories can only
| move along a line perpendicular to the paths. If
| `freeform`, the categories can freely move on the
| plane. If `fixed`, the categories and dimensions are
| stationary.
| bundlecolors
| Sort paths so that like colors are bundled together
| within each category.
| counts
| The number of observations represented by each state.
| Defaults to 1 so that each state represents one
| observation
| countssrc
| Sets the source reference on Chart Studio Cloud for
| `counts`.
| dimensions
| The dimensions (variables) of the parallel categories
| diagram.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets
| the default property values to use for elements of
| parcats.dimensions
| domain
| :class:`plotly.graph_objects.parcats.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoveron
| Sets the hover interaction mode for the parcats
| diagram. If `category`, hover interaction take place
| per category. If `color`, hover interactions take place
| per color per category. If `dimension`, hover
| interactions take place across all categories per
| dimension.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. This value here applies when hovering
| over dimensions. Note that `*categorycount`,
| "colorcount" and "bandcolorcount" are only available
| when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`,
| `probability`, `category`, `categorycount`,
| `colorcount` and `bandcolorcount`. Anything contained
| in tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| labelfont
| Sets the font for the `dimension` labels.
| legendgrouptitle
| :class:`plotly.graph_objects.parcats.Legendgrouptitle`
| instance or dict with compatible properties
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcats.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort
| paths based on dimension categories from left to right.
| If `backward`, sort paths based on dimensions
| categories from right to left.
| stream
| :class:`plotly.graph_objects.parcats.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `category` labels.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Parcats
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| arrangement
| Sets the drag interaction mode for categories and dimensions.
| If `perpendicular`, the categories can only move along a line
| perpendicular to the paths. If `freeform`, the categories can
| freely move on the plane. If `fixed`, the categories and
| dimensions are stationary.
|
| The 'arrangement' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['perpendicular', 'freeform', 'fixed']
|
| Returns
| -------
| Any
|
| bundlecolors
| Sort paths so that like colors are bundled together within each
| category.
|
| The 'bundlecolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| counts
| The number of observations represented by each state. Defaults
| to 1 so that each state represents one observation
|
| The 'counts' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| countssrc
| Sets the source reference on Chart Studio Cloud for `counts`.
|
| The 'countssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets the
| default property values to use for elements of
| parcats.dimensions
|
| The 'dimensiondefaults' property is an instance of Dimension
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Dimension`
| - A dict of string/value properties that will be passed
| to the Dimension constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.parcats.Dimension
|
| dimensions
| The dimensions (variables) of the parallel categories diagram.
|
| The 'dimensions' property is a tuple of instances of
| Dimension that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.parcats.Dimension
| - A list or tuple of dicts of string/value properties that
| will be passed to the Dimension constructor
|
| Supported dict properties:
|
| categoryarray
| Sets the order in which categories in this
| dimension appear. Only has an effect if
| `categoryorder` is set to "array". Used with
| `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the categories
| in the dimension. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`.
| displayindex
| The display index of dimension, from left to
| right, zero indexed, defaults to dimension
| index.
| label
| The shown name of the dimension.
| ticktext
| Sets alternative tick labels for the categories
| in this dimension. Only has an effect if
| `categoryorder` is set to "array". Should be an
| array the same length as `categoryarray` Used
| with `categoryorder`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| values
| Dimension values. `values[n]` represents the
| category value of the `n`th point in the
| dataset, therefore the `values` vector for all
| dimensions must be the same (longer vectors
| will be truncated).
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
| visible
| Shows the dimension when set to `true` (the
| default). Hides the dimension for `false`.
|
| Returns
| -------
| tuple[plotly.graph_objs.parcats.Dimension]
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this parcats trace
| .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this parcats trace .
| x
| Sets the horizontal domain of this parcats
| trace (in plot fraction).
| y
| Sets the vertical domain of this parcats trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.parcats.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['count', 'probability'] joined with '+' characters
| (e.g. 'count+probability')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
| Returns
| -------
| Any
|
| hoveron
| Sets the hover interaction mode for the parcats diagram. If
| `category`, hover interaction take place per category. If
| `color`, hover interactions take place per color per category.
| If `dimension`, hover interactions take place across all
| categories per dimension.
|
| The 'hoveron' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['category', 'color', 'dimension']
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. This value
| here applies when hovering over dimensions. Note that
| `*categorycount`, "colorcount" and "bandcolorcount" are only
| available when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`, `probability`,
| `category`, `categorycount`, `colorcount` and `bandcolorcount`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| labelfont
| Sets the font for the `dimension` labels.
|
| The 'labelfont' property is an instance of Labelfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Labelfont`
| - A dict of string/value properties that will be passed
| to the Labelfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcats.Labelfont
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.parcats.Legendgrouptitle
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `line.colorscale`. Has an effect
| only if in `line.color` is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `line.color`) or the bounds set in
| `line.cmin` and `line.cmax` Has an effect only
| if in `line.color` is set to a numerical array.
| Defaults to `false` when `line.cmin` and
| `line.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `line.cmin` and/or `line.cmax` to be
| equidistant to this point. Has an effect only
| if in `line.color` is set to a numerical array.
| Value should have the same units as in
| `line.color`. Has no effect when `line.cauto`
| is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmax` must be set as well.
| color
| Sets the line color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `line.cmin` and `line.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.parcats.line.Color
| Bar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `line.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `line.cmin` and `line.cmax`.
| Alternatively, `colorscale` may be a palette
| name string of the following list: Blackbody,Bl
| uered,Blues,Cividis,Earth,Electric,Greens,Greys
| ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
| dis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| hovertemplate
| Template string used for rendering the
| information that appear on hover box. Note that
| this will override `hoverinfo`. Variables are
| inserted using %{variable}, for example "y:
| %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for
| several points, "xother" will be added to those
| with different x positions from the first
| point. An underscore before or after
| "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price:
| %{y:$.2f}". https://github.com/d3/d3-
| format/tree/v1.4.5#d3-format for details on the
| formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-
| format}, for example "Day: %{2019-01-01|%A}".
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on
| the date formatting syntax. The variables
| available in `hovertemplate` are the ones
| emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-
| events/#event-data. Additionally, every
| attributes that can be specified per-point (the
| ones that are `arrayOk: true`) are available.
| This value here applies when hovering over
| lines.Finally, the template string has access
| to variables `count` and `probability`.
| Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `line.color` is set to a
| numerical array. If true, `line.cmin` will
| correspond to the last color in the array and
| `line.cmax` will correspond to the first color.
| shape
| Sets the shape of the paths. If `linear`, paths
| are composed of straight lines. If `hspline`,
| paths are composed of horizontal curved splines
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `line.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.parcats.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort paths based
| on dimension categories from left to right. If `backward`, sort
| paths based on dimensions categories from right to left.
|
| The 'sortpaths' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['forward', 'backward']
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.parcats.Stream
|
| tickfont
| Sets the font for the `category` labels.
|
| The 'tickfont' property is an instance of Tickfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Tickfont`
| - A dict of string/value properties that will be passed
| to the Tickfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcats.Tickfont
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Parcoords(plotly.basedatatypes.BaseTraceType)
| Parcoords(arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Parcoords
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Parcoords object
|
| Parallel coordinates for multidimensional exploratory data
| analysis. The samples are specified in `dimensions`. The colors
| are set in `line.color`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Parcoords`
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets
| the default property values to use for elements of
| parcoords.dimensions
| domain
| :class:`plotly.graph_objects.parcoords.Domain` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| labelangle
| Sets the angle of the labels with respect to the
| horizontal. For example, a `tickangle` of -90 draws the
| labels vertically. Tilted labels with "labelangle" may
| be positioned better inside margins when
| `labelposition` is set to "bottom".
| labelfont
| Sets the font for the `dimension` labels.
| labelside
| Specifies the location of the `label`. "top" positions
| labels above, next to the title "bottom" positions
| labels below the graph Tilted labels with "labelangle"
| may be positioned better inside margins when
| `labelposition` is set to "bottom".
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.parcoords.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcoords.Line` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| rangefont
| Sets the font for the `dimension` range values.
| stream
| :class:`plotly.graph_objects.parcoords.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.parcoords.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Parcoords
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets the
| default property values to use for elements of
| parcoords.dimensions
|
| The 'dimensiondefaults' property is an instance of Dimension
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Dimension`
| - A dict of string/value properties that will be passed
| to the Dimension constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.parcoords.Dimension
|
| dimensions
| The dimensions (variables) of the parallel coordinates chart.
| 2..60 dimensions are supported.
|
| The 'dimensions' property is a tuple of instances of
| Dimension that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.parcoords.Dimension
| - A list or tuple of dicts of string/value properties that
| will be passed to the Dimension constructor
|
| Supported dict properties:
|
| constraintrange
| The domain range to which the filter on the
| dimension is constrained. Must be an array of
| `[fromValue, toValue]` with `fromValue <=
| toValue`, or if `multiselect` is not disabled,
| you may give an array of arrays, where each
| inner array is `[fromValue, toValue]`.
| label
| The shown name of the dimension.
| multiselect
| Do we allow multiple selection ranges or just a
| single range?
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| range
| The domain range that represents the full,
| shown axis extent. Defaults to the `values`
| extent. Must be an array of `[fromValue,
| toValue]` with finite numbers as elements.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| values
| Dimension values. `values[n]` represents the
| value of the `n`th point in the dataset,
| therefore the `values` vector for all
| dimensions must be the same (longer vectors
| will be truncated). Each value must be a finite
| number.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
| visible
| Shows the dimension when set to `true` (the
| default). Hides the dimension for `false`.
|
| Returns
| -------
| tuple[plotly.graph_objs.parcoords.Dimension]
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this parcoords
| trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this parcoords trace .
| x
| Sets the horizontal domain of this parcoords
| trace (in plot fraction).
| y
| Sets the vertical domain of this parcoords
| trace (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.parcoords.Domain
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| labelangle
| Sets the angle of the labels with respect to the horizontal.
| For example, a `tickangle` of -90 draws the labels vertically.
| Tilted labels with "labelangle" may be positioned better inside
| margins when `labelposition` is set to "bottom".
|
| The 'labelangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| labelfont
| Sets the font for the `dimension` labels.
|
| The 'labelfont' property is an instance of Labelfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Labelfont`
| - A dict of string/value properties that will be passed
| to the Labelfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Labelfont
|
| labelside
| Specifies the location of the `label`. "top" positions labels
| above, next to the title "bottom" positions labels below the
| graph Tilted labels with "labelangle" may be positioned better
| inside margins when `labelposition` is set to "bottom".
|
| The 'labelside' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top', 'bottom']
|
| Returns
| -------
| Any
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `line.colorscale`. Has an effect
| only if in `line.color` is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `line.color`) or the bounds set in
| `line.cmin` and `line.cmax` Has an effect only
| if in `line.color` is set to a numerical array.
| Defaults to `false` when `line.cmin` and
| `line.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `line.cmin` and/or `line.cmax` to be
| equidistant to this point. Has an effect only
| if in `line.color` is set to a numerical array.
| Value should have the same units as in
| `line.color`. Has no effect when `line.cauto`
| is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmax` must be set as well.
| color
| Sets the line color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `line.cmin` and `line.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.parcoords.line.Col
| orBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `line.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `line.cmin` and `line.cmax`.
| Alternatively, `colorscale` may be a palette
| name string of the following list: Blackbody,Bl
| uered,Blues,Cividis,Earth,Electric,Greens,Greys
| ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
| dis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `line.color` is set to a
| numerical array. If true, `line.cmin` will
| correspond to the last color in the array and
| `line.cmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `line.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| rangefont
| Sets the font for the `dimension` range values.
|
| The 'rangefont' property is an instance of Rangefont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Rangefont`
| - A dict of string/value properties that will be passed
| to the Rangefont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Rangefont
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Stream
|
| tickfont
| Sets the font for the `dimension` tick values.
|
| The 'tickfont' property is an instance of Tickfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Tickfont`
| - A dict of string/value properties that will be passed
| to the Tickfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Tickfont
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.parcoords.unselect
| ed.Line` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.parcoords.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Pie(plotly.basedatatypes.BaseTraceType)
| Pie(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Pie
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Pie object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Pie`
| automargin
| Determines whether outside text labels can push the
| margins.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| direction
| Specifies the direction at which succeeding sectors
| follow one another.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.pie.Domain` instance or
| dict with compatible properties
| hole
| Sets the fraction of the radius to cut out of the pie.
| Use this to make a donut chart.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pie.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pie.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pie.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector.
| pull
| Sets the fraction of larger radius to pull the sectors
| out from the center. This can be a constant to pull all
| slices apart from each other equally or an array to
| highlight one or more slices.
| pullsrc
| Sets the source reference on Chart Studio Cloud for
| `pull`.
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pie charts that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.pie.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.pie.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the
| font used for `title`. Note that the title's font used
| to be set by the now deprecated `titlefont` attribute.
| titleposition
| Deprecated: Please use pie.title.position instead.
| Specifies the location of the `title`. Note that the
| title's position used to be set by the now deprecated
| `titleposition` attribute.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Pie
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| automargin
| Determines whether outside text labels can push the margins.
|
| The 'automargin' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| direction
| Specifies the direction at which succeeding sectors follow one
| another.
|
| The 'direction' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['clockwise', 'counterclockwise']
|
| Returns
| -------
| Any
|
| dlabel
| Sets the label step. See `label0` for more info.
|
| The 'dlabel' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this pie trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this pie trace .
| x
| Sets the horizontal domain of this pie trace
| (in plot fraction).
| y
| Sets the vertical domain of this pie trace (in
| plot fraction).
|
| Returns
| -------
| plotly.graph_objs.pie.Domain
|
| hole
| Sets the fraction of the radius to cut out of the pie. Use this
| to make a donut chart.
|
| The 'hole' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.pie.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `label`, `color`,
| `value`, `percent` and `text`. Anything contained in tag
| `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.pie.Insidetextfont
|
| insidetextorientation
| Controls the orientation of the text inside chart sectors. When
| set to "auto", text may be oriented in any direction in order
| to be as big as possible in the middle of a sector. The
| "horizontal" option orients text to be parallel with the bottom
| of the chart, and may make text smaller in order to achieve
| that goal. The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text perpendicular
| to the radius of the sector.
|
| The 'insidetextorientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['horizontal', 'radial', 'tangential', 'auto']
|
| Returns
| -------
| Any
|
| label0
| Alternate to `labels`. Builds a numeric set of labels. Use with
| `dlabel` where `label0` is the starting label and `dlabel` the
| step.
|
| The 'label0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| labels
| Sets the sector labels. If `labels` entries are duplicated, we
| sum associated `values` or simply count occurrences if `values`
| is not provided. For other array attributes (including color)
| we use the first non-empty entry among all occurrences of the
| label.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.pie.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| colors
| Sets the color of each sector. If not
| specified, the default trace color set is used
| to pick the sector colors.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.pie.marker.Line`
| instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
|
| Returns
| -------
| plotly.graph_objs.pie.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.pie.Outsidetextfont
|
| pull
| Sets the fraction of larger radius to pull the sectors out from
| the center. This can be a constant to pull all slices apart
| from each other equally or an array to highlight one or more
| slices.
|
| The 'pull' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| pullsrc
| Sets the source reference on Chart Studio Cloud for `pull`.
|
| The 'pullsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| rotation
| Instead of the first slice starting at 12 o'clock, rotate to
| some other angle.
|
| The 'rotation' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| scalegroup
| If there are multiple pie charts that should be sized according
| to their totals, link them by providing a non-empty group id
| here shared by every trace in the same group.
|
| The 'scalegroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.pie.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.pie.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `textinfo`.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `label`,
| `color`, `value`, `percent` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| font
| Sets the font used for `title`. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| position
| Specifies the location of the `title`. Note
| that the title's position used to be set by the
| now deprecated `titleposition` attribute.
| text
| Sets the title of the chart. If it is empty, no
| title is displayed. Note that before the
| existence of `title.text`, the title's contents
| used to be defined as the `title` attribute
| itself. This behavior has been deprecated.
|
| Returns
| -------
| plotly.graph_objs.pie.Title
|
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the font
| used for `title`. Note that the title's font used to be set by
| the now deprecated `titlefont` attribute.
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.title.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
|
| titleposition
| Deprecated: Please use pie.title.position instead. Specifies
| the location of the `title`. Note that the title's position
| used to be set by the now deprecated `titleposition` attribute.
|
| The 'position' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle center',
| 'bottom left', 'bottom center', 'bottom right']
|
| Returns
| -------
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Pointcloud(plotly.basedatatypes.BaseTraceType)
| Pointcloud(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, **kwargs)
|
| Method resolution order:
| Pointcloud
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, **kwargs)
| Construct a new Pointcloud object
|
| "pointcloud" trace is deprecated! Please consider switching to
| the "scattergl" trace type. The data visualized as a point
| cloud set in `x` and `y` using the WebGl plotting engine.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Pointcloud`
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pointcloud.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| indices
| A sequential value, 0..n, supply it to avoid creating
| this array inside plotting. If specified, it must be a
| typed `Int32Array` array. Its length must be equal to
| or greater than the number of points. For the best
| performance and memory use, create one large `indices`
| typed array that is guaranteed to be at least as long
| as the largest number of points during use, and reuse
| it on each `Plotly.restyle()` call.
| indicessrc
| Sets the source reference on Chart Studio Cloud for
| `indices`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pointcloud.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pointcloud.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.pointcloud.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `ybounds` for the performance
| benefits.
| xboundssrc
| Sets the source reference on Chart Studio Cloud for
| `xbounds`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xy
| Faster alternative to specifying `x` and `y`
| separately. If supplied, it must be a typed
| `Float32Array` array that represents points such that
| `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`
| xysrc
| Sets the source reference on Chart Studio Cloud for
| `xy`.
| y
| Sets the y coordinates.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `xbounds` for the performance
| benefits.
| yboundssrc
| Sets the source reference on Chart Studio Cloud for
| `ybounds`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
|
| Returns
| -------
| Pointcloud
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| indices
| A sequential value, 0..n, supply it to avoid creating this
| array inside plotting. If specified, it must be a typed
| `Int32Array` array. Its length must be equal to or greater than
| the number of points. For the best performance and memory use,
| create one large `indices` typed array that is guaranteed to be
| at least as long as the largest number of points during use,
| and reuse it on each `Plotly.restyle()` call.
|
| The 'indices' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| indicessrc
| Sets the source reference on Chart Studio Cloud for `indices`.
|
| The 'indicessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| blend
| Determines if colors are blended together for a
| translucency effect in case `opacity` is
| specified as a value less then `1`. Setting
| `blend` to `true` reduces zoom/pan speed if
| used with large numbers of points.
| border
| :class:`plotly.graph_objects.pointcloud.marker.
| Border` instance or dict with compatible
| properties
| color
| Sets the marker fill color. It accepts a
| specific color. If the color is not fully
| opaque and there are hundreds of thousands of
| points, it may cause slower zooming and
| panning.
| opacity
| Sets the marker opacity. The default value is
| `1` (fully opaque). If the markers are not
| fully opaque and there are hundreds of
| thousands of points, it may cause slower
| zooming and panning. Opacity fades the color
| even if `blend` is left on `false` even if
| there is no translucency effect in that case.
| sizemax
| Sets the maximum size (in px) of the rendered
| marker points. Effective when the `pointcloud`
| shows only few points.
| sizemin
| Sets the minimum size (in px) of the rendered
| marker points, effective when the `pointcloud`
| shows a million or more points.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to avoid
| looping through the `xy` typed array. Use it in conjunction
| with `xy` and `ybounds` for the performance benefits.
|
| The 'xbounds' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xboundssrc
| Sets the source reference on Chart Studio Cloud for `xbounds`.
|
| The 'xboundssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xy
| Faster alternative to specifying `x` and `y` separately. If
| supplied, it must be a typed `Float32Array` array that
| represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 +
| 1] = y[i]`
|
| The 'xy' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xysrc
| Sets the source reference on Chart Studio Cloud for `xy`.
|
| The 'xysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to avoid
| looping through the `xy` typed array. Use it in conjunction
| with `xy` and `xbounds` for the performance benefits.
|
| The 'ybounds' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yboundssrc
| Sets the source reference on Chart Studio Cloud for `ybounds`.
|
| The 'yboundssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class RadialAxis(builtins.dict)
| RadialAxis(*args, **kwargs)
|
| plotly.graph_objs.RadialAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.RadialAxis
| - plotly.graph_objs.layout.polar.RadialAxis
|
| Method resolution order:
| RadialAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.RadialAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.RadialAxis
| - plotly.graph_objs.layout.polar.RadialAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Sankey(plotly.basedatatypes.BaseTraceType)
| Sankey(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)
|
| Method resolution order:
| Sankey
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)
| Construct a new Sankey object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Sankey`
| arrangement
| If value is `snap` (the default), the node arrangement
| is assisted by automatic snapping of elements to
| preserve space between nodes specified via `nodepad`.
| If value is `perpendicular`, the nodes can only move
| along a line perpendicular to the flow. If value is
| `freeform`, the nodes can freely move on the plane. If
| value is `fixed`, the nodes are stationary.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sankey.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired. Note that this attribute is
| superseded by `node.hoverinfo` and `node.hoverinfo` for
| nodes and links respectively.
| hoverlabel
| :class:`plotly.graph_objects.sankey.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sankey.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| link
| The links of the Sankey plot.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| orientation
| Sets the orientation of the Sankey diagram.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| stream
| :class:`plotly.graph_objects.sankey.Stream` instance or
| dict with compatible properties
| textfont
| Sets the font for node labels
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| valuesuffix
| Adds a unit to follow the value in the hover tooltip.
| Add a space if a separation is necessary from the
| value.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Sankey
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| arrangement
| If value is `snap` (the default), the node arrangement is
| assisted by automatic snapping of elements to preserve space
| between nodes specified via `nodepad`. If value is
| `perpendicular`, the nodes can only move along a line
| perpendicular to the flow. If value is `freeform`, the nodes
| can freely move on the plane. If value is `fixed`, the nodes
| are stationary.
|
| The 'arrangement' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['snap', 'perpendicular', 'freeform', 'fixed']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this sankey trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this sankey trace .
| x
| Sets the horizontal domain of this sankey trace
| (in plot fraction).
| y
| Sets the vertical domain of this sankey trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.sankey.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
| Note that this attribute is superseded by `node.hoverinfo` and
| `node.hoverinfo` for nodes and links respectively.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of [] joined with '+' characters
| (e.g. '')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
| Returns
| -------
| Any
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.sankey.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.sankey.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| link
| The links of the Sankey plot.
|
| The 'link' property is an instance of Link
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Link`
| - A dict of string/value properties that will be passed
| to the Link constructor
|
| Supported dict properties:
|
| arrowlen
| Sets the length (in px) of the links arrow, if
| 0 no arrow will be drawn.
| color
| Sets the `link` color. It can be a single
| value, or an array for specifying color for
| each `link`. If `link.color` is omitted, then
| by default, a translucent grey link will be
| used.
| colorscales
| A tuple of :class:`plotly.graph_objects.sankey.
| link.Colorscale` instances or dicts with
| compatible properties
| colorscaledefaults
| When used in a template (as layout.template.dat
| a.sankey.link.colorscaledefaults), sets the
| default property values to use for elements of
| sankey.link.colorscales
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| customdata
| Assigns extra data to each link.
| customdatasrc
| Sets the source reference on Chart Studio Cloud
| for `customdata`.
| hovercolor
| Sets the `link` hover color. It can be a single
| value, or an array for specifying hover colors
| for each `link`. If `link.hovercolor` is
| omitted, then by default, links will become
| slightly more opaque when hovered over.
| hovercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `hovercolor`.
| hoverinfo
| Determines which trace information appear when
| hovering links. If `none` or `skip` are set, no
| information is displayed upon hovering. But, if
| `none` is set, click and hover events are still
| fired.
| hoverlabel
| :class:`plotly.graph_objects.sankey.link.Hoverl
| abel` instance or dict with compatible
| properties
| hovertemplate
| Template string used for rendering the
| information that appear on hover box. Note that
| this will override `hoverinfo`. Variables are
| inserted using %{variable}, for example "y:
| %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for
| several points, "xother" will be added to those
| with different x positions from the first
| point. An underscore before or after
| "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price:
| %{y:$.2f}". https://github.com/d3/d3-
| format/tree/v1.4.5#d3-format for details on the
| formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-
| format}, for example "Day: %{2019-01-01|%A}".
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on
| the date formatting syntax. The variables
| available in `hovertemplate` are the ones
| emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-
| events/#event-data. Additionally, every
| attributes that can be specified per-point (the
| ones that are `arrayOk: true`) are available.
| Variables `source` and `target` are node
| objects.Finally, the template string has access
| to variables `value` and `label`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud
| for `hovertemplate`.
| label
| The shown name of the link.
| labelsrc
| Sets the source reference on Chart Studio Cloud
| for `label`.
| line
| :class:`plotly.graph_objects.sankey.link.Line`
| instance or dict with compatible properties
| source
| An integer number `[0..nodes.length - 1]` that
| represents the source node.
| sourcesrc
| Sets the source reference on Chart Studio Cloud
| for `source`.
| target
| An integer number `[0..nodes.length - 1]` that
| represents the target node.
| targetsrc
| Sets the source reference on Chart Studio Cloud
| for `target`.
| value
| A numeric value representing the flow volume
| value.
| valuesrc
| Sets the source reference on Chart Studio Cloud
| for `value`.
|
| Returns
| -------
| plotly.graph_objs.sankey.Link
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| node
| The nodes of the Sankey plot.
|
| The 'node' property is an instance of Node
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Node`
| - A dict of string/value properties that will be passed
| to the Node constructor
|
| Supported dict properties:
|
| align
| Sets the alignment method used to position the
| nodes along the horizontal axis.
| color
| Sets the `node` color. It can be a single
| value, or an array for specifying color for
| each `node`. If `node.color` is omitted, then
| the default `Plotly` color palette will be
| cycled through to have a variety of colors.
| These defaults are not fully opaque, to allow
| some visibility of what is beneath the node.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| customdata
| Assigns extra data to each node.
| customdatasrc
| Sets the source reference on Chart Studio Cloud
| for `customdata`.
| groups
| Groups of nodes. Each group is defined by an
| array with the indices of the nodes it
| contains. Multiple groups can be specified.
| hoverinfo
| Determines which trace information appear when
| hovering nodes. If `none` or `skip` are set, no
| information is displayed upon hovering. But, if
| `none` is set, click and hover events are still
| fired.
| hoverlabel
| :class:`plotly.graph_objects.sankey.node.Hoverl
| abel` instance or dict with compatible
| properties
| hovertemplate
| Template string used for rendering the
| information that appear on hover box. Note that
| this will override `hoverinfo`. Variables are
| inserted using %{variable}, for example "y:
| %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for
| several points, "xother" will be added to those
| with different x positions from the first
| point. An underscore before or after
| "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price:
| %{y:$.2f}". https://github.com/d3/d3-
| format/tree/v1.4.5#d3-format for details on the
| formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-
| format}, for example "Day: %{2019-01-01|%A}".
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on
| the date formatting syntax. The variables
| available in `hovertemplate` are the ones
| emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-
| events/#event-data. Additionally, every
| attributes that can be specified per-point (the
| ones that are `arrayOk: true`) are available.
| Variables `sourceLinks` and `targetLinks` are
| arrays of link objects.Finally, the template
| string has access to variables `value` and
| `label`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud
| for `hovertemplate`.
| label
| The shown name of the node.
| labelsrc
| Sets the source reference on Chart Studio Cloud
| for `label`.
| line
| :class:`plotly.graph_objects.sankey.node.Line`
| instance or dict with compatible properties
| pad
| Sets the padding (in px) between the `nodes`.
| thickness
| Sets the thickness (in px) of the `nodes`.
| x
| The normalized horizontal position of the node.
| xsrc
| Sets the source reference on Chart Studio Cloud
| for `x`.
| y
| The normalized vertical position of the node.
| ysrc
| Sets the source reference on Chart Studio Cloud
| for `y`.
|
| Returns
| -------
| plotly.graph_objs.sankey.Node
|
| orientation
| Sets the orientation of the Sankey diagram.
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.sankey.Stream
|
| textfont
| Sets the font for node labels
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.sankey.Textfont
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| valueformat
| Sets the value formatting rule using d3 formatting mini-
| languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
| The 'valueformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| valuesuffix
| Adds a unit to follow the value in the hover tooltip. Add a
| space if a separation is necessary from the value.
|
| The 'valuesuffix' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatter(plotly.basedatatypes.BaseTraceType)
| Scatter(arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Scatter
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Scatter object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scatter`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scatter.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available. If fillgradient is
| specified, fillcolor is ignored except for setting the
| background color of the hover label, if any.
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor
| is used instead.
| fillpattern
| Sets the pattern within the marker.
| groupnorm
| Only relevant when `stackgroup` is used, and only the
| first `groupnorm` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Sets the normalization for the sum of
| this `stackgroup`. With "fraction", the value of each
| trace at each location is divided by the sum of all
| trace values at that location. "percent" is the same
| but multiplied by 100 to show percentages. If there are
| multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Only relevant in the following cases: 1. when
| `scattermode` is set to "group". 2. when `stackgroup`
| is used, and only the first `orientation` found in the
| `stackgroup` will be used - including if `visible` is
| "legendonly" but not if it is `false`. Sets the
| stacking direction. With "v" ("h"), the y (x) values of
| subsequent traces are added. Also affects the default
| value of `fill`.
| selected
| :class:`plotly.graph_objects.scatter.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stackgaps
| Only relevant when `stackgroup` is used, and only the
| first `stackgaps` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Determines how we handle locations at
| which other traces in this group have data but this one
| does not. With *infer zero* we insert a zero at these
| locations. With "interpolate" we linearly interpolate
| between existing values, and extrapolate a constant
| beyond the existing values.
| stackgroup
| Set several scatter traces (on the same subplot) to the
| same stackgroup in order to add their y values (or
| their x values if `orientation` is "h"). If blank or
| omitted this trace will not be stacked. Stacking also
| turns `fill` on by default, using "tonexty" ("tonextx")
| if `orientation` is "h" ("v") and sets the default
| `mode` to "lines" irrespective of point count. You can
| only stack on a numeric (linear or log) axis. Traces in
| a `stackgroup` will only fill to (or be filled to)
| other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if
| fill-linked traces are not already consecutive, the
| later ones will be pushed down in the drawing order.
| stream
| :class:`plotly.graph_objects.scatter.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatter.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Scatter
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter.ErrorY
|
| fill
| Sets the area to fill with a solid color. Defaults to "none"
| unless this trace is stacked, then it gets "tonexty"
| ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor`
| if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0
| respectively. "tonextx" and "tonexty" fill between the
| endpoints of this trace and the endpoints of the trace before
| it, connecting those endpoints with straight lines (to make a
| stacked area graph); if there is no trace before it, they
| behave like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if it has
| gaps) into a closed shape. "tonext" fills the space between two
| traces if one completely encloses the other (eg consecutive
| contour lines), and behaves like "toself" if there is no trace
| before it. "tonext" should not be used if one trace does not
| enclose the other. Traces in a `stackgroup` will only fill to
| (or be filled to) other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if fill-
| linked traces are not already consecutive, the later ones will
| be pushed down in the drawing order.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx',
| 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available. If fillgradient is specified, fillcolor is
| ignored except for setting the background color of the hover
| label, if any.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor is used
| instead.
|
| The 'fillgradient' property is an instance of Fillgradient
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Fillgradient`
| - A dict of string/value properties that will be passed
| to the Fillgradient constructor
|
| Supported dict properties:
|
| colorscale
| Sets the fill gradient colors as a color scale.
| The color scale is interpreted as a gradient
| applied in the direction specified by
| "orientation", from the lowest to the highest
| value of the scatter plot along that axis, or
| from the center to the most distant point from
| it, if orientation is "radial".
| start
| Sets the gradient start value. It is given as
| the absolute position on the axis determined by
| the orientiation. E.g., if orientation is
| "horizontal", the gradient will be horizontal
| and start from the x-position given by start.
| If omitted, the gradient starts at the lowest
| value of the trace along the respective axis.
| Ignored if orientation is "radial".
| stop
| Sets the gradient end value. It is given as the
| absolute position on the axis determined by the
| orientiation. E.g., if orientation is
| "horizontal", the gradient will be horizontal
| and end at the x-position given by end. If
| omitted, the gradient ends at the highest value
| of the trace along the respective axis. Ignored
| if orientation is "radial".
| type
| Sets the type/orientation of the color gradient
| for the fill. Defaults to "none".
|
| Returns
| -------
| plotly.graph_objs.scatter.Fillgradient
|
| fillpattern
| Sets the pattern within the marker.
|
| The 'fillpattern' property is an instance of Fillpattern
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Fillpattern`
| - A dict of string/value properties that will be passed
| to the Fillpattern constructor
|
| Supported dict properties:
|
| bgcolor
| When there is no colorscale sets the color of
| background pattern fill. Defaults to a
| `marker.color` background when `fillmode` is
| "overlay". Otherwise, defaults to a transparent
| background.
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| fgcolor
| When there is no colorscale sets the color of
| foreground pattern fill. Defaults to a
| `marker.color` background when `fillmode` is
| "replace". Otherwise, defaults to dark grey or
| white to increase contrast with the `bgcolor`.
| fgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `fgcolor`.
| fgopacity
| Sets the opacity of the foreground pattern
| fill. Defaults to a 0.5 when `fillmode` is
| "overlay". Otherwise, defaults to 1.
| fillmode
| Determines whether `marker.color` should be
| used as a default to `bgcolor` or a `fgcolor`.
| shape
| Sets the shape of the pattern fill. By default,
| no pattern is used for filling the area.
| shapesrc
| Sets the source reference on Chart Studio Cloud
| for `shape`.
| size
| Sets the size of unit squares of the pattern
| fill in pixels, which corresponds to the
| interval of repetition of the pattern.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| solidity
| Sets the solidity of the pattern fill. Solidity
| is roughly the fraction of the area filled by
| the pattern. Solidity of 0 shows only the
| background color without pattern and solidty of
| 1 shows only the foreground color without
| pattern.
| soliditysrc
| Sets the source reference on Chart Studio Cloud
| for `solidity`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Fillpattern
|
| groupnorm
| Only relevant when `stackgroup` is used, and only the first
| `groupnorm` found in the `stackgroup` will be used - including
| if `visible` is "legendonly" but not if it is `false`. Sets the
| normalization for the sum of this `stackgroup`. With
| "fraction", the value of each trace at each location is divided
| by the sum of all trace values at that location. "percent" is
| the same but multiplied by 100 to show percentages. If there
| are multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
|
| The 'groupnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'fraction', 'percent']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatter.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| simplify
| Simplifies lines by removing nearly-collinear
| points. When transitioning lines, it may be
| desirable to disable this so that the number of
| points along the resulting SVG path is
| unaffected.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatter.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatter.marker.Col
| orBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scatter.marker.Gra
| dient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scatter.marker.Lin
| e` instance or dict with compatible properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Only relevant in the following cases: 1. when `scattermode` is
| set to "group". 2. when `stackgroup` is used, and only the
| first `orientation` found in the `stackgroup` will be used -
| including if `visible` is "legendonly" but not if it is
| `false`. Sets the stacking direction. With "v" ("h"), the y (x)
| values of subsequent traces are added. Also affects the default
| value of `fill`.
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatter.selected.M
| arker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatter.selected.T
| extfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatter.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stackgaps
| Only relevant when `stackgroup` is used, and only the first
| `stackgaps` found in the `stackgroup` will be used - including
| if `visible` is "legendonly" but not if it is `false`.
| Determines how we handle locations at which other traces in
| this group have data but this one does not. With *infer zero*
| we insert a zero at these locations. With "interpolate" we
| linearly interpolate between existing values, and extrapolate a
| constant beyond the existing values.
|
| The 'stackgaps' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['infer zero', 'interpolate']
|
| Returns
| -------
| Any
|
| stackgroup
| Set several scatter traces (on the same subplot) to the same
| stackgroup in order to add their y values (or their x values if
| `orientation` is "h"). If blank or omitted this trace will not
| be stacked. Stacking also turns `fill` on by default, using
| "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets
| the default `mode` to "lines" irrespective of point count. You
| can only stack on a numeric (linear or log) axis. Traces in a
| `stackgroup` will only fill to (or be filled to) other traces
| in the same group. With multiple `stackgroup`s or some traces
| stacked and some not, if fill-linked traces are not already
| consecutive, the later ones will be pushed down in the drawing
| order.
|
| The 'stackgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatter.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatter.unselected
| .Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatter.unselected
| .Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatter.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatter3d(plotly.basedatatypes.BaseTraceType)
| Scatter3d(arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Scatter3d
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Scatter3d object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scatter3d`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.scatter3d.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter3d.ErrorY` instance
| or dict with compatible properties
| error_z
| :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter3d.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter3d.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| projection
| :class:`plotly.graph_objects.scatter3d.Projection`
| instance or dict with compatible properties
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatter3d.Stream` instance
| or dict with compatible properties
| surfaceaxis
| If "-1", the scatter points are not fill with a surface
| If 0, 1, 2, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Scatter3d
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_zstyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_zstyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.ErrorY
|
| error_z
| The 'error_z' property is an instance of ErrorZ
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.ErrorZ`
| - A dict of string/value properties that will be passed
| to the ErrorZ constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.ErrorZ
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets text elements associated with each (x,y,z) triplet. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y,z) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `line.colorscale`. Has an effect
| only if in `line.color` is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `line.color`) or the bounds set in
| `line.cmin` and `line.cmax` Has an effect only
| if in `line.color` is set to a numerical array.
| Defaults to `false` when `line.cmin` and
| `line.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `line.cmin` and/or `line.cmax` to be
| equidistant to this point. Has an effect only
| if in `line.color` is set to a numerical array.
| Value should have the same units as in
| `line.color`. Has no effect when `line.cauto`
| is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmax` must be set as well.
| color
| Sets the line color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `line.cmin` and `line.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatter3d.line.Col
| orBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `line.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `line.cmin` and `line.cmax`.
| Alternatively, `colorscale` may be a palette
| name string of the following list: Blackbody,Bl
| uered,Blues,Cividis,Earth,Electric,Greens,Greys
| ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
| dis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| dash
| Sets the dash style of the lines.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `line.color` is set to a
| numerical array. If true, `line.cmin` will
| correspond to the last color in the array and
| `line.cmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `line.color` is set to a numerical array.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatter3d.marker.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.scatter3d.marker.L
| ine` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity. Note that the marker
| opacity for scatter3d traces must be a scalar
| value for performance reasons. To set a
| blending opacity value (i.e. which is not
| transparent), set "marker.color" to an rgba
| color and use its alpha channel.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| projection
| The 'projection' property is an instance of Projection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Projection`
| - A dict of string/value properties that will be passed
| to the Projection constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.scatter3d.projecti
| on.X` instance or dict with compatible
| properties
| y
| :class:`plotly.graph_objects.scatter3d.projecti
| on.Y` instance or dict with compatible
| properties
| z
| :class:`plotly.graph_objects.scatter3d.projecti
| on.Z` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Projection
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Stream
|
| surfaceaxis
| If "-1", the scatter points are not fill with a surface If 0,
| 1, 2, the scatter points are filled with a Delaunay surface
| about the x, y, z respectively.
|
| The 'surfaceaxis' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [-1, 0, 1, 2]
|
| Returns
| -------
| Any
|
| surfacecolor
| Sets the surface fill color.
|
| The 'surfacecolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y,z) triplet. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y,z) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zcalendar
| Sets the calendar system to use with `z` date data.
|
| The 'zcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattercarpet(plotly.basedatatypes.BaseTraceType)
| Scattercarpet(arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)
|
| Method resolution order:
| Scattercarpet
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)
| Construct a new Scattercarpet object
|
| Plots a scatter trace on either the first carpet axis or the
| carpet axis with a matching `carpet` attribute.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattercarpet`
| a
| Sets the a-axis coordinates.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the b-axis coordinates.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattercarpet.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b). To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattercarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattercarpet.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattercarpet.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattercarpet.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattercarpet.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (a,b) point. If
| a single string, the same string appears over all the
| data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattercarpet.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Scattercarpet
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| Sets the a-axis coordinates.
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| b
| Sets the b-axis coordinates.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| carpet
| An identifier for this carpet, so that `scattercarpet` and
| `contourcarpet` traces can specify a carpet plot on which they
| lie
|
| The 'carpet' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scatterternary has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['a', 'b', 'text', 'name'] joined with '+' characters
| (e.g. 'a+b')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (a,b) point. If a
| single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b). To be seen, trace `hoverinfo`
| must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattercarpet.mark
| er.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scattercarpet.mark
| er.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scattercarpet.mark
| er.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattercarpet.sele
| cted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattercarpet.sele
| cted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Stream
|
| text
| Sets text elements associated with each (a,b) point. If a
| single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b). If trace `hoverinfo` contains
| a "text" flag and "hovertext" is not set, these elements will
| be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `a`, `b`
| and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattercarpet.unse
| lected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattercarpet.unse
| lected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattergeo(plotly.basedatatypes.BaseTraceType)
| Scattergeo(arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattergeo
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattergeo object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattergeo`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used
| when `locations` is set. It can be set as a valid
| GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or
| "Feature" with geometries of type "Polygon" or
| "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergeo.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair or item in `locations`. If a single string, the
| same string appears over all the data points. If an
| array of string, the items are mapped in order to the
| this trace's (lon,lat) or `locations` coordinates. To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergeo.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergeo.Line` instance
| or dict with compatible properties
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names.
| Coordinates correspond to the centroid of each location
| given. See `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattergeo.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergeo.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergeo.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (lon,lat) pair
| or item in `locations`. If a single string, the same
| string appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (lon,lat) or `locations` coordinates. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is
| not set, these elements will be seen in the hover
| labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon`, `location` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergeo.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattergeo
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Only has an effect
| when `geojson` is set. Support nested property, for example
| "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". "toself" connects the endpoints of the trace (or
| each segment of the trace if it has gaps) into a closed shape.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| geo
| Sets a reference between this trace's geospatial coordinates
| and a geographic map. If "geo" (the default value), the
| geospatial coordinates refer to `layout.geo`. If "geo2", the
| geospatial coordinates refer to `layout.geo2`, and so on.
|
| The 'geo' property is an identifier of a particular
| subplot, of type 'geo', that may be specified as the string 'geo'
| optionally followed by an integer >= 1
| (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.)
|
| Returns
| -------
| str
|
| geojson
| Sets optional GeoJSON data associated with this trace. If not
| given, the features on the base map are used when `locations`
| is set. It can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of type
| "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'location', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair or
| item in `locations`. If a single string, the same string
| appears over all the data points. If an array of string, the
| items are mapped in order to the this trace's (lon,lat) or
| `locations` coordinates. To be seen, trace `hoverinfo` must
| contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Line
|
| locationmode
| Determines the set of locations used to match entries in
| `locations` to regions on the map. Values "ISO-3", "USA-
| states", *country names* correspond to features on the base map
| and value "geojson-id" corresponds to features from a custom
| GeoJSON linked to the `geojson` attribute.
|
| The 'locationmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['ISO-3', 'USA-states', 'country names', 'geojson-id']
|
| Returns
| -------
| Any
|
| locations
| Sets the coordinates via location IDs or names. Coordinates
| correspond to the centroid of each location given. See
| `locationmode` for more info.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| With "north", angle 0 points north based on the
| current map projection.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattergeo.marker.
| ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scattergeo.marker.
| Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scattergeo.marker.
| Line` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergeo.selecte
| d.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergeo.selecte
| d.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Stream
|
| text
| Sets text elements associated with each (lon,lat) pair or item
| in `locations`. If a single string, the same string appears
| over all the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat) or `locations`
| coordinates. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `lat`,
| `lon`, `location` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergeo.unselec
| ted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergeo.unselec
| ted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattergl(plotly.basedatatypes.BaseTraceType)
| Scattergl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)
|
| Method resolution order:
| Scattergl
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)
| Construct a new Scattergl object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattergl`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scattergl.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scattergl.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergl.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattergl.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergl.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
|
| Returns
| -------
| Scattergl
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scattergl.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scattergl.ErrorY
|
| fill
| Sets the area to fill with a solid color. Defaults to "none"
| unless this trace is stacked, then it gets "tonexty"
| ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor`
| if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0
| respectively. "tonextx" and "tonexty" fill between the
| endpoints of this trace and the endpoints of the trace before
| it, connecting those endpoints with straight lines (to make a
| stacked area graph); if there is no trace before it, they
| behave like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if it has
| gaps) into a closed shape. "tonext" fills the space between two
| traces if one completely encloses the other (eg consecutive
| contour lines), and behaves like "toself" if there is no trace
| before it. "tonext" should not be used if one trace does not
| enclose the other. Traces in a `stackgroup` will only fill to
| (or be filled to) other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if fill-
| linked traces are not already consecutive, the later ones will
| be pushed down in the drawing order.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx',
| 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| dash
| Sets the style of the lines.
| shape
| Determines the line shape. The values
| correspond to step-wise line shapes.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattergl.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattergl.marker.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.scattergl.marker.L
| ine` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergl.selected
| .Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergl.selected
| .Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergl.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergl.unselect
| ed.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergl.unselect
| ed.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergl.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattermap(plotly.basedatatypes.BaseTraceType)
| Scattermap(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattermap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattermap object
|
| The data visualized as scatter point, lines or marker symbols
| on a MapLibre GL geographic map is provided by
| longitude/latitude pairs in `lon` and `lat`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattermap`
| below
| Determines if this scattermap trace's layers are to be
| inserted before the layer with the specified ID. By
| default, scattermap layers are inserted above all the
| base layers. To place the scattermap layers above every
| other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermap.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermap.Line` instance
| or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=map.layer.paint.text-
| color, size=map.layer.layout.text-size). Has an effect
| only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattermap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| below
| Determines if this scattermap trace's layers are to be inserted
| before the layer with the specified ID. By default, scattermap
| layers are inserted above all the base layers. To place the
| scattermap layers above every other layer, set `below` to "''".
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cluster
| The 'cluster' property is an instance of Cluster
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Cluster`
| - A dict of string/value properties that will be passed
| to the Cluster constructor
|
| Supported dict properties:
|
| color
| Sets the color for each cluster step.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| enabled
| Determines whether clustering is enabled or
| disabled.
| maxzoom
| Sets the maximum zoom level. At zoom levels
| equal to or greater than this, points will
| never be clustered.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| size
| Sets the size for each cluster step.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| step
| Sets how many points it takes to create a
| cluster or advance to the next cluster step.
| Use this in conjunction with arrays for `size`
| and / or `color`. If an integer, steps start at
| multiples of this number. If an array, each
| step extends from the given value until one
| less than the next value.
| stepsrc
| Sets the source reference on Chart Studio Cloud
| for `step`.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Cluster
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". "toself" connects the endpoints of the trace (or
| each segment of the trace if it has gaps) into a closed shape.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattermap.Line
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| allowoverlap
| Flag to draw all symbols, even if they overlap.
| angle
| Sets the marker orientation from true North, in
| degrees clockwise. When using the "auto"
| default, no rotation would be applied in
| perspective views which is different from using
| a zero angle.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattermap.marker.
| ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol. Full list:
| https://www.map.com/maki-icons/ Note that the
| array `marker.color` and `marker.size` are only
| available for "circle" symbols.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermap.selecte
| d.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermap.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| map subplot. If "map" (the default value), the data refer to
| `layout.map`. If "map2", the data refer to `layout.map2`, and
| so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'map', that may be specified as the string 'map'
| optionally followed by an integer >= 1
| (e.g. 'map', 'map1', 'map2', 'map3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the icon text font (color=map.layer.paint.text-color,
| size=map.layer.layout.text-size). Has an effect only when
| `type` is set to "symbol".
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `lat`,
| `lon` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermap.unselec
| ted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermap.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattermapbox(plotly.basedatatypes.BaseTraceType)
| Scattermapbox(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattermapbox
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattermapbox object
|
| "scattermapbox" trace is deprecated! Please consider switching
| to the "scattermap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ The data
| visualized as scatter point, lines or marker symbols on a
| Mapbox GL geographic map is provided by longitude/latitude
| pairs in `lon` and `lat`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattermapbox`
| below
| Determines if this scattermapbox trace's layers are to
| be inserted before the layer with the specified ID. By
| default, scattermapbox layers are inserted above all
| the base layers. To place the scattermapbox layers
| above every other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermapbox.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermapbox.Line`
| instance or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-
| color, size=mapbox.layer.layout.text-size). Has an
| effect only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermapbox.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattermapbox
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| below
| Determines if this scattermapbox trace's layers are to be
| inserted before the layer with the specified ID. By default,
| scattermapbox layers are inserted above all the base layers. To
| place the scattermapbox layers above every other layer, set
| `below` to "''".
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cluster
| The 'cluster' property is an instance of Cluster
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Cluster`
| - A dict of string/value properties that will be passed
| to the Cluster constructor
|
| Supported dict properties:
|
| color
| Sets the color for each cluster step.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| enabled
| Determines whether clustering is enabled or
| disabled.
| maxzoom
| Sets the maximum zoom level. At zoom levels
| equal to or greater than this, points will
| never be clustered.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| size
| Sets the size for each cluster step.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| step
| Sets how many points it takes to create a
| cluster or advance to the next cluster step.
| Use this in conjunction with arrays for `size`
| and / or `color`. If an integer, steps start at
| multiples of this number. If an array, each
| step extends from the given value until one
| less than the next value.
| stepsrc
| Sets the source reference on Chart Studio Cloud
| for `step`.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Cluster
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". "toself" connects the endpoints of the trace (or
| each segment of the trace if it has gaps) into a closed shape.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Line
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| allowoverlap
| Flag to draw all symbols, even if they overlap.
| angle
| Sets the marker orientation from true North, in
| degrees clockwise. When using the "auto"
| default, no rotation would be applied in
| perspective views which is different from using
| a zero angle.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattermapbox.mark
| er.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol. Full list:
| https://www.mapbox.com/maki-icons/ Note that
| the array `marker.color` and `marker.size` are
| only available for "circle" symbols.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermapbox.sele
| cted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Stream
|
| subplot
| mapbox subplots and traces are deprecated! Please consider
| switching to `map` subplots and traces. Learn more at:
| https://plotly.com/javascript/maplibre-migration/ Sets a
| reference between this trace's data coordinates and a mapbox
| subplot. If "mapbox" (the default value), the data refer to
| `layout.mapbox`. If "mapbox2", the data refer to
| `layout.mapbox2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'mapbox', that may be specified as the string 'mapbox'
| optionally followed by an integer >= 1
| (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-color,
| size=mapbox.layer.layout.text-size). Has an effect only when
| `type` is set to "symbol".
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `lat`,
| `lon` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermapbox.unse
| lected.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatterpolar(plotly.basedatatypes.BaseTraceType)
| Scatterpolar(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scatterpolar
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scatterpolar object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scatterpolar`
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterpolar has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolar.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolar.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolar.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolar.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolar.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scatterpolar
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dr
| Sets the r coordinate step.
|
| The 'dr' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dtheta
| Sets the theta coordinate step. By default, the `dtheta` step
| equals the subplot's period divided by the length of the `r`
| coordinates.
|
| The 'dtheta' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scatterpolar has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters
| (e.g. 'r+theta')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatterpolar.marke
| r.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scatterpolar.marke
| r.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scatterpolar.marke
| r.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| r
| Sets the radial coordinates
|
| The 'r' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| r0
| Alternate to `r`. Builds a linear space of r coordinates. Use
| with `dr` where `r0` is the starting coordinate and `dr` the
| step.
|
| The 'r0' property accepts values of any type
|
| Returns
| -------
| Any
|
| rsrc
| Sets the source reference on Chart Studio Cloud for `r`.
|
| The 'rsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolar.selec
| ted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterpolar.selec
| ted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| polar subplot. If "polar" (the default value), the data refer
| to `layout.polar`. If "polar2", the data refer to
| `layout.polar2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'polar', that may be specified as the string 'polar'
| optionally followed by an integer >= 1
| (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `r`,
| `theta` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| theta
| Sets the angular coordinates
|
| The 'theta' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the starting
| coordinate and `dtheta` the step.
|
| The 'theta0' property accepts values of any type
|
| Returns
| -------
| Any
|
| thetasrc
| Sets the source reference on Chart Studio Cloud for `theta`.
|
| The 'thetasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| thetaunit
| Sets the unit of input "theta" values. Has an effect only when
| on "linear" angular axes.
|
| The 'thetaunit' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['radians', 'degrees', 'gradians']
|
| Returns
| -------
| Any
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolar.unsel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterpolar.unsel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatterpolargl(plotly.basedatatypes.BaseTraceType)
| Scatterpolargl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scatterpolargl
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scatterpolargl object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Scatterpolargl`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolargl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolargl.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolargl.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolargl.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolargl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolargl.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolargl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scatterpolargl
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dr
| Sets the r coordinate step.
|
| The 'dr' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dtheta
| Sets the theta coordinate step. By default, the `dtheta` step
| equals the subplot's period divided by the length of the `r`
| coordinates.
|
| The 'dtheta' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fill
| Sets the area to fill with a solid color. Defaults to "none"
| unless this trace is stacked, then it gets "tonexty"
| ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor`
| if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0
| respectively. "tonextx" and "tonexty" fill between the
| endpoints of this trace and the endpoints of the trace before
| it, connecting those endpoints with straight lines (to make a
| stacked area graph); if there is no trace before it, they
| behave like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if it has
| gaps) into a closed shape. "tonext" fills the space between two
| traces if one completely encloses the other (eg consecutive
| contour lines), and behaves like "toself" if there is no trace
| before it. "tonext" should not be used if one trace does not
| enclose the other. Traces in a `stackgroup` will only fill to
| (or be filled to) other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if fill-
| linked traces are not already consecutive, the later ones will
| be pushed down in the drawing order.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx',
| 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters
| (e.g. 'r+theta')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| dash
| Sets the style of the lines.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatterpolargl.mar
| ker.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.scatterpolargl.mar
| ker.Line` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| r
| Sets the radial coordinates
|
| The 'r' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| r0
| Alternate to `r`. Builds a linear space of r coordinates. Use
| with `dr` where `r0` is the starting coordinate and `dr` the
| step.
|
| The 'r0' property accepts values of any type
|
| Returns
| -------
| Any
|
| rsrc
| Sets the source reference on Chart Studio Cloud for `r`.
|
| The 'rsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolargl.sel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterpolargl.sel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| polar subplot. If "polar" (the default value), the data refer
| to `layout.polar`. If "polar2", the data refer to
| `layout.polar2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'polar', that may be specified as the string 'polar'
| optionally followed by an integer >= 1
| (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `r`,
| `theta` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| theta
| Sets the angular coordinates
|
| The 'theta' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the starting
| coordinate and `dtheta` the step.
|
| The 'theta0' property accepts values of any type
|
| Returns
| -------
| Any
|
| thetasrc
| Sets the source reference on Chart Studio Cloud for `theta`.
|
| The 'thetasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| thetaunit
| Sets the unit of input "theta" values. Has an effect only when
| on "linear" angular axes.
|
| The 'thetaunit' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['radians', 'degrees', 'gradians']
|
| Returns
| -------
| Any
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolargl.uns
| elected.Marker` instance or dict with
| compatible properties
| textfont
| :class:`plotly.graph_objects.scatterpolargl.uns
| elected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattersmith(plotly.basedatatypes.BaseTraceType)
| Scattersmith(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattersmith
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattersmith object
|
| The scattersmith trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in smith coordinates.
| The data visualized as scatter point or lines is set in `real`
| and `imag` (imaginary) coordinates Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattersmith`
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scattersmith has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattersmith.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| imagsrc
| Sets the source reference on Chart Studio Cloud for
| `imag`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattersmith.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattersmith.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattersmith.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| real
| Sets the real component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| realsrc
| Sets the source reference on Chart Studio Cloud for
| `real`.
| selected
| :class:`plotly.graph_objects.scattersmith.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattersmith.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a smith subplot. If "smith" (the default value),
| the data refer to `layout.smith`. If "smith2", the data
| refer to `layout.smith2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `real`, `imag` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattersmith.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattersmith
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scattersmith has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['real', 'imag', 'text', 'name'] joined with '+' characters
| (e.g. 'real+imag')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the center of
| the chart.
|
| The 'imag' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| imagsrc
| Sets the source reference on Chart Studio Cloud for `imag`.
|
| The 'imagsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattersmith.marke
| r.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scattersmith.marke
| r.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scattersmith.marke
| r.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| real
| Sets the real component of the data, in units of normalized
| impedance such that real=1, imag=0 is the center of the chart.
|
| The 'real' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| realsrc
| Sets the source reference on Chart Studio Cloud for `real`.
|
| The 'realsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattersmith.selec
| ted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattersmith.selec
| ted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| smith subplot. If "smith" (the default value), the data refer
| to `layout.smith`. If "smith2", the data refer to
| `layout.smith2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'smith', that may be specified as the string 'smith'
| optionally followed by an integer >= 1
| (e.g. 'smith', 'smith1', 'smith2', 'smith3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `real`,
| `imag` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattersmith.unsel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattersmith.unsel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatterternary(plotly.basedatatypes.BaseTraceType)
| Scatterternary(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scatterternary
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scatterternary object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Scatterternary`
| a
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on Chart Studio Cloud for
| `c`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterternary.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b,c)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b,c).
| To be seen, trace `hoverinfo` must contain a "text"
| flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterternary.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterternary.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterternary.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scatterternary.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterternary.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If "ternary" (the default
| value), the data refer to `layout.ternary`. If
| "ternary2", the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b`, `c` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterternary.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scatterternary
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| Sets the quantity of component `a` in each data point. If `a`,
| `b`, and `c` are all provided, they need not be normalized,
| only the relative values matter. If only two arrays are
| provided they must be normalized to match `ternary<i>.sum`.
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| b
| Sets the quantity of component `a` in each data point. If `a`,
| `b`, and `c` are all provided, they need not be normalized,
| only the relative values matter. If only two arrays are
| provided they must be normalized to match `ternary<i>.sum`.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| c
| Sets the quantity of component `a` in each data point. If `a`,
| `b`, and `c` are all provided, they need not be normalized,
| only the relative values matter. If only two arrays are
| provided they must be normalized to match `ternary<i>.sum`.
|
| The 'c' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| csrc
| Sets the source reference on Chart Studio Cloud for `c`.
|
| The 'csrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scatterternary has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['a', 'b', 'c', 'text', 'name'] joined with '+' characters
| (e.g. 'a+b')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (a,b,c) point. If
| a single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b,c). To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatterternary.mar
| ker.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scatterternary.mar
| ker.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scatterternary.mar
| ker.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterternary.sel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterternary.sel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| ternary subplot. If "ternary" (the default value), the data
| refer to `layout.ternary`. If "ternary2", the data refer to
| `layout.ternary2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'ternary', that may be specified as the string 'ternary'
| optionally followed by an integer >= 1
| (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.)
|
| Returns
| -------
| str
|
| sum
| The number each triplet should sum to, if only two of `a`, `b`,
| and `c` are provided. This overrides `ternary<i>.sum` to
| normalize this specific trace, but does not affect the values
| displayed on the axes. 0 (or missing) means to use
| ternary<i>.sum
|
| The 'sum' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| text
| Sets text elements associated with each (a,b,c) point. If a
| single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b,c). If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `a`, `b`,
| `c` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterternary.uns
| elected.Marker` instance or dict with
| compatible properties
| textfont
| :class:`plotly.graph_objects.scatterternary.uns
| elected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scene(builtins.dict)
| Scene(*args, **kwargs)
|
| plotly.graph_objs.Scene is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Scene
|
| Method resolution order:
| Scene
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Scene is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Scene
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Splom(plotly.basedatatypes.BaseTraceType)
| Splom(arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)
|
| Method resolution order:
| Splom
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)
| Construct a new Splom object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Splom`
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| diagonal
| :class:`plotly.graph_objects.splom.Diagonal` instance
| or dict with compatible properties
| dimensions
| A tuple of
| :class:`plotly.graph_objects.splom.Dimension` instances
| or dicts with compatible properties
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the
| default property values to use for elements of
| splom.dimensions
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.splom.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.splom.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.splom.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.splom.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showlowerhalf
| Determines whether or not subplots on the lower half
| from the diagonal are displayed.
| showupperhalf
| Determines whether or not subplots on the upper half
| from the diagonal are displayed.
| stream
| :class:`plotly.graph_objects.splom.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair to
| appear on hover. If a single string, the same string
| appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.splom.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxes
| Sets the list of x axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N xaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| yaxes
| Sets the list of y axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N yaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
|
| Returns
| -------
| Splom
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| diagonal
| The 'diagonal' property is an instance of Diagonal
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Diagonal`
| - A dict of string/value properties that will be passed
| to the Diagonal constructor
|
| Supported dict properties:
|
| visible
| Determines whether or not subplots on the
| diagonal are displayed.
|
| Returns
| -------
| plotly.graph_objs.splom.Diagonal
|
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the default
| property values to use for elements of splom.dimensions
|
| The 'dimensiondefaults' property is an instance of Dimension
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Dimension`
| - A dict of string/value properties that will be passed
| to the Dimension constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.splom.Dimension
|
| dimensions
| The 'dimensions' property is a tuple of instances of
| Dimension that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.splom.Dimension
| - A list or tuple of dicts of string/value properties that
| will be passed to the Dimension constructor
|
| Supported dict properties:
|
| axis
| :class:`plotly.graph_objects.splom.dimension.Ax
| is` instance or dict with compatible properties
| label
| Sets the label corresponding to this splom
| dimension.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| values
| Sets the dimension values to be plotted.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
| visible
| Determines whether or not this dimension is
| shown on the graph. Note that even visible
| false dimension contribute to the default grid
| generate by this splom trace.
|
| Returns
| -------
| tuple[plotly.graph_objs.splom.Dimension]
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.splom.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.splom.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.splom.marker.Color
| Bar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.splom.marker.Line`
| instance or dict with compatible properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.splom.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.splom.selected.Mar
| ker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.splom.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlowerhalf
| Determines whether or not subplots on the lower half from the
| diagonal are displayed.
|
| The 'showlowerhalf' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showupperhalf
| Determines whether or not subplots on the upper half from the
| diagonal are displayed.
|
| The 'showupperhalf' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.splom.Stream
|
| text
| Sets text elements associated with each (x,y) pair to appear on
| hover. If a single string, the same string appears over all the
| data points. If an array of string, the items are mapped in
| order to the this trace's (x,y) coordinates.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.splom.unselected.M
| arker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.splom.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| xaxes
| Sets the list of x axes corresponding to dimensions of this
| splom trace. By default, a splom will match the first N xaxes
| where N is the number of input dimensions. Note that, in case
| where `diagonal.visible` is false and `showupperhalf` or
| `showlowerhalf` is false, this splom trace will generate one
| less x-axis and one less y-axis.
|
| The 'xaxes' property is an info array that may be specified as:
| * a list of elements where:
| The 'xaxes[i]' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| list
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yaxes
| Sets the list of y axes corresponding to dimensions of this
| splom trace. By default, a splom will match the first N yaxes
| where N is the number of input dimensions. Note that, in case
| where `diagonal.visible` is false and `showupperhalf` or
| `showlowerhalf` is false, this splom trace will generate one
| less x-axis and one less y-axis.
|
| The 'yaxes' property is an info array that may be specified as:
| * a list of elements where:
| The 'yaxes[i]' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| list
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Stream(builtins.dict)
| Stream(*args, **kwargs)
|
| plotly.graph_objs.Stream is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Stream
| - plotly.graph_objs.area.Stream
|
| Method resolution order:
| Stream
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Stream is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Stream
| - plotly.graph_objs.area.Stream
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Streamtube(plotly.basedatatypes.BaseTraceType)
| Streamtube(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Streamtube
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Streamtube object
|
| Use a streamtube trace to visualize flow in a vector field.
| Specify a vector field using 6 1D arrays of equal length, 3
| position arrays `x`, `y` and `z` and 3 vector component arrays
| `u`, `v`, and `w`. By default, the tubes' starting positions
| will be cut from the vector field's x-z plane at its minimum y
| value. To specify your own starting position, use attributes
| `starts.x`, `starts.y` and `starts.z`. The color is encoded by
| the norm of (u, v, w), and the local radius by the divergence
| of (u, v, w).
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Streamtube`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.streamtube.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.streamtube.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `tubex`, `tubey`, `tubez`, `tubeu`,
| `tubev`, `tubew`, `norm` and `divergence`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.streamtube.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.streamtube.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.streamtube.Lightposition`
| instance or dict with compatible properties
| maxdisplayed
| The maximum number of displayed segments in a
| streamtube.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizeref
| The scaling factor for the streamtubes. The default is
| 1, which avoids two max divergence tubes from touching
| at adjacent starting positions.
| starts
| :class:`plotly.graph_objects.streamtube.Starts`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.streamtube.Stream`
| instance or dict with compatible properties
| text
| Sets a text element associated with this trace. If
| trace `hoverinfo` contains a "text" flag, this text
| element will be seen in all hover labels. Note that
| streamtube traces do not support array `text` values.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Streamtube
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here u/v/w norm) or the bounds set
| in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmin` must be set as
| well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as u/v/w norm. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmax` must be set as
| well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.streamt
| ube.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.streamtube.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of streamtube.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.streamtube.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| streamtube.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| streamtube.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.streamtube.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `tubex`, `tubey`,
| `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Lightposition
|
| maxdisplayed
| The maximum number of displayed segments in a streamtube.
|
| The 'maxdisplayed' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sizeref
| The scaling factor for the streamtubes. The default is 1, which
| avoids two max divergence tubes from touching at adjacent
| starting positions.
|
| The 'sizeref' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| starts
| The 'starts' property is an instance of Starts
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Starts`
| - A dict of string/value properties that will be passed
| to the Starts constructor
|
| Supported dict properties:
|
| x
| Sets the x components of the starting position
| of the streamtubes
| xsrc
| Sets the source reference on Chart Studio Cloud
| for `x`.
| y
| Sets the y components of the starting position
| of the streamtubes
| ysrc
| Sets the source reference on Chart Studio Cloud
| for `y`.
| z
| Sets the z components of the starting position
| of the streamtubes
| zsrc
| Sets the source reference on Chart Studio Cloud
| for `z`.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Starts
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Stream
|
| text
| Sets a text element associated with this trace. If trace
| `hoverinfo` contains a "text" flag, this text element will be
| seen in all hover labels. Note that streamtube traces do not
| support array `text` values.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| u
| Sets the x components of the vector field.
|
| The 'u' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'uhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| usrc
| Sets the source reference on Chart Studio Cloud for `u`.
|
| The 'usrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| v
| Sets the y components of the vector field.
|
| The 'v' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'vhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| vsrc
| Sets the source reference on Chart Studio Cloud for `v`.
|
| The 'vsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| w
| Sets the z components of the vector field.
|
| The 'w' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| whoverformat
| Sets the hover text formatting rulefor `w` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'whoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| wsrc
| Sets the source reference on Chart Studio Cloud for `w`.
|
| The 'wsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates of the vector field.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates of the vector field.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates of the vector field.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Sunburst(plotly.basedatatypes.BaseTraceType)
| Sunburst(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Sunburst
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Sunburst object
|
| Visualize hierarchal data spanning outward radially from root
| to leaves. The sunburst sectors are determined by the entries
| in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Sunburst`
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sunburst.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.sunburst.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.sunburst.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sunburst.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.sunburst.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented at the center of a sunburst graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| root
| :class:`plotly.graph_objects.sunburst.Root` instance or
| dict with compatible properties
| rotation
| Rotates the whole diagram counterclockwise by some
| angle. By default the first slice starts at 3 o'clock.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.sunburst.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Sunburst
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| branchvalues
| Determines how the items in `values` are summed. When set to
| "total", items in `values` are taken to be value of all its
| descendants. When set to "remainder", items in `values`
| corresponding to the root and the branches sectors are taken to
| be the extra part not part of the sum of the values at their
| leaves.
|
| The 'branchvalues' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['remainder', 'total']
|
| Returns
| -------
| Any
|
| count
| Determines default for `values` when it is not provided, by
| inferring a 1 for each of the "leaves" and/or "branches",
| otherwise 0.
|
| The 'count' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['branches', 'leaves'] joined with '+' characters
| (e.g. 'branches+leaves')
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this sunburst trace
| .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this sunburst trace .
| x
| Sets the horizontal domain of this sunburst
| trace (in plot fraction).
| y
| Sets the vertical domain of this sunburst trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.sunburst.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `currentPath`, `root`,
| `entry`, `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Insidetextfont
|
| insidetextorientation
| Controls the orientation of the text inside chart sectors. When
| set to "auto", text may be oriented in any direction in order
| to be as big as possible in the middle of a sector. The
| "horizontal" option orients text to be parallel with the bottom
| of the chart, and may make text smaller in order to achieve
| that goal. The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text perpendicular
| to the radius of the sector.
|
| The 'insidetextorientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['horizontal', 'radial', 'tangential', 'auto']
|
| Returns
| -------
| Any
|
| labels
| Sets the labels of each of the sectors.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| leaf
| The 'leaf' property is an instance of Leaf
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Leaf`
| - A dict of string/value properties that will be passed
| to the Leaf constructor
|
| Supported dict properties:
|
| opacity
| Sets the opacity of the leaves. With colorscale
| it is defaulted to 1; otherwise it is defaulted
| to 0.7
|
| Returns
| -------
| plotly.graph_objs.sunburst.Leaf
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| level
| Sets the level from which this trace hierarchy is rendered. Set
| `level` to `''` to start from the root node in the hierarchy.
| Must be an "id" if `ids` is filled in, otherwise plotly
| attempts to find a matching item in `labels`.
|
| The 'level' property accepts values of any type
|
| Returns
| -------
| Any
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if colors is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| colors) or the bounds set in `marker.cmin` and
| `marker.cmax` Has an effect only if colors is
| set to a numerical array. Defaults to `false`
| when `marker.cmin` and `marker.cmax` are set by
| the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmin` must be set as
| well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if colors is set to a numerical array.
| Value should have the same units as colors. Has
| no effect when `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmax` must be set as
| well.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.sunburst.marker.Co
| lorBar` instance or dict with compatible
| properties
| colors
| Sets the color of each sector of this trace. If
| not specified, the default trace color set is
| used to pick the sector colors.
| colorscale
| Sets the colorscale. Has an effect only if
| colors is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.sunburst.marker.Li
| ne` instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if colors is set to a numerical
| array. If true, `marker.cmin` will correspond
| to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| colors is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Marker
|
| maxdepth
| Sets the number of rendered sectors from any given `level`. Set
| `maxdepth` to "-1" to render all the levels in the hierarchy.
|
| The 'maxdepth' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
| This option refers to the root of the hierarchy presented at
| the center of a sunburst graph. Please note that if a hierarchy
| has multiple root nodes, this option won't have any effect and
| `insidetextfont` would be used.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Outsidetextfont
|
| parents
| Sets the parent sectors for each of the sectors. Empty string
| items '' are understood to reference the root node in the
| hierarchy. If `ids` is filled, `parents` items are understood
| to be "ids" themselves. When `ids` is not set, plotly attempts
| to find matching items in `labels`, but beware they must be
| unique.
|
| The 'parents' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| parentssrc
| Sets the source reference on Chart Studio Cloud for `parents`.
|
| The 'parentssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| root
| The 'root' property is an instance of Root
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Root`
| - A dict of string/value properties that will be passed
| to the Root constructor
|
| Supported dict properties:
|
| color
| sets the color of the root node for a
| sunburst/treemap/icicle trace. this has no
| effect when a colorscale is used to set the
| markers.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Root
|
| rotation
| Rotates the whole diagram counterclockwise by some angle. By
| default the first slice starts at 3 o'clock.
|
| The 'rotation' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
| `percentParent`, `label` and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values associated with each of the sectors. Use with
| `branchvalues` to determine how the values are summed.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Surface(plotly.basedatatypes.BaseTraceType)
| Surface(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Surface
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Surface object
|
| The data the describes the coordinates of the surface is set in
| `z`. Data in `z` should be a 2D list. Coordinates in `x` and
| `y` can either be 1D lists or 2D lists (e.g. to graph
| parametric surfaces). If not provided in `x` and `y`, the x and
| y coordinates are assumed to be linear starting at 0 with a
| unit step. The color scale corresponds to the `z` values by
| default. For custom color scales, use `surfacecolor` which
| should be a 2D list, where its bounds can be controlled using
| `cmin` and `cmax`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Surface`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here z or surfacecolor)
| or the bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as z or surfacecolor.
| Has no effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmax` must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.surface.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| :class:`plotly.graph_objects.surface.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hidesurface
| Determines whether or not a surface is drawn. For
| example, set `hidesurface` to False `contours.x.show`
| to True and `contours.y.show` to True to draw a wire
| frame plot.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.surface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.surface.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.surface.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.surface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.surface.Stream` instance
| or dict with compatible properties
| surfacecolor
| Sets the surface color values, used for setting a color
| scale independent of `z`.
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
| text
| Sets the text elements associated with each z value. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Surface
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here z or surfacecolor) or the
| bounds set in `cmin` and `cmax` Defaults to `false` when `cmin`
| and `cmax` are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as z or surfacecolor and if set, `cmin` must be set
| as well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as z or surfacecolor. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as z or surfacecolor and if set, `cmax` must be set
| as well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.surface
| .colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.surface.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of surface.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.surface.colorbar.T
| itle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| surface.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| surface.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.surface.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data are filled in.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.surface.contours.X
| ` instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.surface.contours.Y
| ` instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.surface.contours.Z
| ` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.surface.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hidesurface
| Determines whether or not a surface is drawn. For example, set
| `hidesurface` to False `contours.x.show` to True and
| `contours.y.show` to True to draw a wire frame plot.
|
| The 'hidesurface' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.surface.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.surface.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
|
| Returns
| -------
| plotly.graph_objs.surface.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.surface.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| opacityscale
| Sets the opacityscale. The opacityscale must be an array
| containing arrays mapping a normalized value to an opacity
| value. At minimum, a mapping for the lowest (0) and highest (1)
| values are required. For example, `[[0, 1], [0.5, 0.2], [1,
| 1]]` means that higher/lower values would have higher opacity
| values and those in the middle would be more transparent
| Alternatively, `opacityscale` may be a palette name string of
| the following list: 'min', 'max', 'extremes' and 'uniform'. The
| default is 'uniform'.
|
| The 'opacityscale' property accepts values of any type
|
| Returns
| -------
| Any
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.surface.Stream
|
| surfacecolor
| Sets the surface color values, used for setting a color scale
| independent of `z`.
|
| The 'surfacecolor' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
|
| The 'surfacecolorsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| text
| Sets the text elements associated with each z value. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zcalendar
| Sets the calendar system to use with `z` date data.
|
| The 'zcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Table(plotly.basedatatypes.BaseTraceType)
| Table(arg=None, cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)
|
| Method resolution order:
| Table
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)
| Construct a new Table object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Table`
| cells
| :class:`plotly.graph_objects.table.Cells` instance or
| dict with compatible properties
| columnorder
| Specifies the rendered order of the data columns; for
| example, a value `2` at position `0` means that column
| index `0` in the data will be rendered as the third
| column, as columns have an index base of zero.
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
| columnwidth
| The width of columns expressed as a ratio. Columns fill
| the available width in proportion of their specified
| column widths.
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.table.Domain` instance or
| dict with compatible properties
| header
| :class:`plotly.graph_objects.table.Header` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.table.Hoverlabel` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.table.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| stream
| :class:`plotly.graph_objects.table.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Table
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cells
| The 'cells' property is an instance of Cells
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Cells`
| - A dict of string/value properties that will be passed
| to the Cells constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the `text`
| within the box. Has an effect only if `text`
| spans two or more lines (i.e. `text` contains
| one or more <br> HTML tags) or if an explicit
| width is set to override the text width.
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| fill
| :class:`plotly.graph_objects.table.cells.Fill`
| instance or dict with compatible properties
| font
| :class:`plotly.graph_objects.table.cells.Font`
| instance or dict with compatible properties
| format
| Sets the cell value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| formatsrc
| Sets the source reference on Chart Studio Cloud
| for `format`.
| height
| The height of cells.
| line
| :class:`plotly.graph_objects.table.cells.Line`
| instance or dict with compatible properties
| prefix
| Prefix for cell values.
| prefixsrc
| Sets the source reference on Chart Studio Cloud
| for `prefix`.
| suffix
| Suffix for cell values.
| suffixsrc
| Sets the source reference on Chart Studio Cloud
| for `suffix`.
| values
| Cell values. `values[m][n]` represents the
| value of the `n`th point in column `m`,
| therefore the `values[m]` vector length for all
| columns must be the same (longer vectors will
| be truncated). Each value must be a finite
| number or a string.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
|
| Returns
| -------
| plotly.graph_objs.table.Cells
|
| columnorder
| Specifies the rendered order of the data columns; for example,
| a value `2` at position `0` means that column index `0` in the
| data will be rendered as the third column, as columns have an
| index base of zero.
|
| The 'columnorder' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
|
| The 'columnordersrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| columnwidth
| The width of columns expressed as a ratio. Columns fill the
| available width in proportion of their specified column widths.
|
| The 'columnwidth' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
|
| The 'columnwidthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this table trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this table trace .
| x
| Sets the horizontal domain of this table trace
| (in plot fraction).
| y
| Sets the vertical domain of this table trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.table.Domain
|
| header
| The 'header' property is an instance of Header
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Header`
| - A dict of string/value properties that will be passed
| to the Header constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the `text`
| within the box. Has an effect only if `text`
| spans two or more lines (i.e. `text` contains
| one or more <br> HTML tags) or if an explicit
| width is set to override the text width.
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| fill
| :class:`plotly.graph_objects.table.header.Fill`
| instance or dict with compatible properties
| font
| :class:`plotly.graph_objects.table.header.Font`
| instance or dict with compatible properties
| format
| Sets the cell value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| formatsrc
| Sets the source reference on Chart Studio Cloud
| for `format`.
| height
| The height of cells.
| line
| :class:`plotly.graph_objects.table.header.Line`
| instance or dict with compatible properties
| prefix
| Prefix for cell values.
| prefixsrc
| Sets the source reference on Chart Studio Cloud
| for `prefix`.
| suffix
| Suffix for cell values.
| suffixsrc
| Sets the source reference on Chart Studio Cloud
| for `suffix`.
| values
| Header cell values. `values[m][n]` represents
| the value of the `n`th point in column `m`,
| therefore the `values[m]` vector length for all
| columns must be the same (longer vectors will
| be truncated). Each value must be a finite
| number or a string.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
|
| Returns
| -------
| plotly.graph_objs.table.Header
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.table.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.table.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.table.Stream
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Trace(builtins.dict)
| Trace(*args, **kwargs)
|
| plotly.graph_objs.Trace is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| Method resolution order:
| Trace
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Trace is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Treemap(plotly.basedatatypes.BaseTraceType)
| Treemap(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Treemap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Treemap object
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The treemap sectors are
| determined by the entries in "labels" or "ids" and in
| "parents".
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Treemap`
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.treemap.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.treemap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.treemap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.treemap.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.treemap.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.treemap.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.treemap.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.treemap.Tiling` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Treemap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| branchvalues
| Determines how the items in `values` are summed. When set to
| "total", items in `values` are taken to be value of all its
| descendants. When set to "remainder", items in `values`
| corresponding to the root and the branches sectors are taken to
| be the extra part not part of the sum of the values at their
| leaves.
|
| The 'branchvalues' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['remainder', 'total']
|
| Returns
| -------
| Any
|
| count
| Determines default for `values` when it is not provided, by
| inferring a 1 for each of the "leaves" and/or "branches",
| otherwise 0.
|
| The 'count' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['branches', 'leaves'] joined with '+' characters
| (e.g. 'branches+leaves')
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this treemap trace
| .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this treemap trace .
| x
| Sets the horizontal domain of this treemap
| trace (in plot fraction).
| y
| Sets the vertical domain of this treemap trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.treemap.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `currentPath`, `root`,
| `entry`, `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Insidetextfont
|
| labels
| Sets the labels of each of the sectors.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.treemap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| level
| Sets the level from which this trace hierarchy is rendered. Set
| `level` to `''` to start from the root node in the hierarchy.
| Must be an "id" if `ids` is filled in, otherwise plotly
| attempts to find a matching item in `labels`.
|
| The 'level' property accepts values of any type
|
| Returns
| -------
| Any
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if colors is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| colors) or the bounds set in `marker.cmin` and
| `marker.cmax` Has an effect only if colors is
| set to a numerical array. Defaults to `false`
| when `marker.cmin` and `marker.cmax` are set by
| the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmin` must be set as
| well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if colors is set to a numerical array.
| Value should have the same units as colors. Has
| no effect when `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmax` must be set as
| well.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.treemap.marker.Col
| orBar` instance or dict with compatible
| properties
| colors
| Sets the color of each sector of this trace. If
| not specified, the default trace color set is
| used to pick the sector colors.
| colorscale
| Sets the colorscale. Has an effect only if
| colors is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| cornerradius
| Sets the maximum rounding of corners (in px).
| depthfade
| Determines if the sector colors are faded
| towards the background from the leaves up to
| the headers. This option is unavailable when a
| `colorscale` is present, defaults to false when
| `marker.colors` is set, but otherwise defaults
| to true. When set to "reversed", the fading
| direction is inverted, that is the top elements
| within hierarchy are drawn with fully saturated
| colors while the leaves are faded towards the
| background color.
| line
| :class:`plotly.graph_objects.treemap.marker.Lin
| e` instance or dict with compatible properties
| pad
| :class:`plotly.graph_objects.treemap.marker.Pad
| ` instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if colors is set to a numerical
| array. If true, `marker.cmin` will correspond
| to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| colors is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.treemap.Marker
|
| maxdepth
| Sets the number of rendered sectors from any given `level`. Set
| `maxdepth` to "-1" to render all the levels in the hierarchy.
|
| The 'maxdepth' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
| This option refers to the root of the hierarchy presented on
| top left corner of a treemap graph. Please note that if a
| hierarchy has multiple root nodes, this option won't have any
| effect and `insidetextfont` would be used.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Outsidetextfont
|
| parents
| Sets the parent sectors for each of the sectors. Empty string
| items '' are understood to reference the root node in the
| hierarchy. If `ids` is filled, `parents` items are understood
| to be "ids" themselves. When `ids` is not set, plotly attempts
| to find matching items in `labels`, but beware they must be
| unique.
|
| The 'parents' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| parentssrc
| Sets the source reference on Chart Studio Cloud for `parents`.
|
| The 'parentssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| pathbar
| The 'pathbar' property is an instance of Pathbar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Pathbar`
| - A dict of string/value properties that will be passed
| to the Pathbar constructor
|
| Supported dict properties:
|
| edgeshape
| Determines which shape is used for edges
| between `barpath` labels.
| side
| Determines on which side of the the treemap the
| `pathbar` should be presented.
| textfont
| Sets the font used inside `pathbar`.
| thickness
| Sets the thickness of `pathbar` (in px). If not
| specified the `pathbar.textfont.size` is used
| with 3 pixles extra padding on each side.
| visible
| Determines if the path bar is drawn i.e.
| outside the trace `domain` and with one pixel
| gap.
|
| Returns
| -------
| plotly.graph_objs.treemap.Pathbar
|
| root
| The 'root' property is an instance of Root
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Root`
| - A dict of string/value properties that will be passed
| to the Root constructor
|
| Supported dict properties:
|
| color
| sets the color of the root node for a
| sunburst/treemap/icicle trace. this has no
| effect when a colorscale is used to set the
| markers.
|
| Returns
| -------
| plotly.graph_objs.treemap.Root
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.treemap.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Sets the positions of the `text` elements.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
| `percentParent`, `label` and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| tiling
| The 'tiling' property is an instance of Tiling
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Tiling`
| - A dict of string/value properties that will be passed
| to the Tiling constructor
|
| Supported dict properties:
|
| flip
| Determines if the positions obtained from
| solver are flipped on each axis.
| packing
| Determines d3 treemap solver. For more info
| please refer to
| https://github.com/d3/d3-hierarchy#treemap-
| tiling
| pad
| Sets the inner padding (in px).
| squarifyratio
| When using "squarify" `packing` algorithm,
| according to https://github.com/d3/d3-
| hierarchy/blob/v3.1.1/README.md#squarify_ratio
| this option specifies the desired aspect ratio
| of the generated rectangles. The ratio must be
| specified as a number greater than or equal to
| one. Note that the orientation of the generated
| rectangles (tall or wide) is not implied by the
| ratio; for example, a ratio of two will attempt
| to produce a mixture of rectangles whose
| width:height ratio is either 2:1 or 1:2. When
| using "squarify", unlike d3 which uses the
| Golden Ratio i.e. 1.618034, Plotly applies 1 to
| increase squares in treemap layouts.
|
| Returns
| -------
| plotly.graph_objs.treemap.Tiling
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values associated with each of the sectors. Use with
| `branchvalues` to determine how the values are summed.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Violin(plotly.basedatatypes.BaseTraceType)
| Violin(arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Violin
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Violin object
|
| In vertical (horizontal) violin plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| violin per distinct x (y) value is drawn If no `x` (`y`) list
| is provided, a single violin is drawn. That violin position is
| then positioned with with `name` or with `x0` (`y0`) if
| provided.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Violin`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| bandwidth
| Sets the bandwidth used to compute the kernel density
| estimate. By default, the bandwidth is determined by
| Silverman's rule of thumb.
| box
| :class:`plotly.graph_objects.violin.Box` instance or
| dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.violin.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual violins or
| sample points or the kernel density estimate or any
| combination of them?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the violins.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.violin.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.violin.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.violin.Marker` instance or
| dict with compatible properties
| meanline
| :class:`plotly.graph_objects.violin.Meanline` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For violin traces, the name
| will also be used for the position coordinate, if `x`
| and `x0` (`y` and `y0` if horizontal) are missing and
| the position axis is categorical. Note that the trace
| name is also used as a default value for attribute
| `scalegroup` (please see its description for details).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the violin(s). If "v" ("h"),
| the distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the violins. If 0, the sample points are places over
| the center of the violins. Positive (negative) values
| correspond to positions to the right (left) for
| vertical violins and above (below) for horizontal
| violins.
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the violins are shown with no sample
| points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set, otherwise defaults to "outliers".
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| scalegroup
| If there are multiple violins that should be sized
| according to to some metric (see `scalemode`), link
| them by providing a non-empty group id here shared by
| every trace in the same group. If a violin's `width` is
| undefined, `scalegroup` will default to the trace's
| name. In this case, violins with the same names will be
| linked together
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same
| (max) width "count" means the violins are scaled by the
| number of sample points making up each violin.
| selected
| :class:`plotly.graph_objects.violin.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| side
| Determines on which side of the position value the
| density function making up one half of a violin is
| plotted. Useful when comparing two violin traces under
| "overlay" mode, where one trace has `side` set to
| "positive" and the other to "negative".
| span
| Sets the span in data space for which the density
| function will be computed. Has an effect only when
| `spanmode` is set to "manual".
| spanmode
| Sets the method by which the span in data space where
| the density function will be computed. "soft" means the
| span goes from the sample's minimum value minus two
| bandwidths to the sample's maximum value plus two
| bandwidths. "hard" means the span goes from the
| sample's minimum to its maximum value. For custom span
| settings, use mode "manual" and fill in the `span`
| attribute.
| stream
| :class:`plotly.graph_objects.violin.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.violin.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the width of the violin in data coordinates. If 0
| (default value) the width is automatically selected
| based on the positions of other violin traces in the
| same subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Violin
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| bandwidth
| Sets the bandwidth used to compute the kernel density estimate.
| By default, the bandwidth is determined by Silverman's rule of
| thumb.
|
| The 'bandwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| box
| The 'box' property is an instance of Box
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Box`
| - A dict of string/value properties that will be passed
| to the Box constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the inner box plot fill color.
| line
| :class:`plotly.graph_objects.violin.box.Line`
| instance or dict with compatible properties
| visible
| Determines if an miniature box plot is drawn
| inside the violins.
| width
| Sets the width of the inner box plots relative
| to the violins' width. For example, with 1, the
| inner box plots are as wide as the violins.
|
| Returns
| -------
| plotly.graph_objs.violin.Box
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.violin.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual violins or sample
| points or the kernel density estimate or any combination of
| them?
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['violins', 'points', 'kde'] joined with '+' characters
| (e.g. 'violins+points')
| OR exactly one of ['all'] (e.g. 'all')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| jitter
| Sets the amount of jitter in the sample points drawn. If 0, the
| sample points align along the distribution axis. If 1, the
| sample points are drawn in a random jitter of width equal to
| the width of the violins.
|
| The 'jitter' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.violin.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of line bounding the violin(s).
| width
| Sets the width (in px) of line bounding the
| violin(s).
|
| Returns
| -------
| plotly.graph_objs.violin.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| line
| :class:`plotly.graph_objects.violin.marker.Line
| ` instance or dict with compatible properties
| opacity
| Sets the marker opacity.
| outliercolor
| Sets the color of the outlier sample points.
| size
| Sets the marker size (in px).
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
|
| Returns
| -------
| plotly.graph_objs.violin.Marker
|
| meanline
| The 'meanline' property is an instance of Meanline
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Meanline`
| - A dict of string/value properties that will be passed
| to the Meanline constructor
|
| Supported dict properties:
|
| color
| Sets the mean line color.
| visible
| Determines if a line corresponding to the
| sample's mean is shown inside the violins. If
| `box.visible` is turned on, the mean line is
| drawn inside the inner box. Otherwise, the mean
| line is drawn from one side of the violin to
| other.
| width
| Sets the mean line width.
|
| Returns
| -------
| plotly.graph_objs.violin.Meanline
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover. For violin traces, the name will also be used for
| the position coordinate, if `x` and `x0` (`y` and `y0` if
| horizontal) are missing and the position axis is categorical.
| Note that the trace name is also used as a default value for
| attribute `scalegroup` (please see its description for
| details).
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the violin(s). If "v" ("h"), the
| distribution is visualized along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| pointpos
| Sets the position of the sample points in relation to the
| violins. If 0, the sample points are places over the center of
| the violins. Positive (negative) values correspond to positions
| to the right (left) for vertical violins and above (below) for
| horizontal violins.
|
| The 'pointpos' property is a number and may be specified as:
| - An int or float in the interval [-2, 2]
|
| Returns
| -------
| int|float
|
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier points
| are shown and points either less than 4*Q1-3*Q3 or greater than
| 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all
| sample points are shown If False, only the violins are shown
| with no sample points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is set,
| otherwise defaults to "outliers".
|
| The 'points' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['all', 'outliers', 'suspectedoutliers', False]
|
| Returns
| -------
| Any
|
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile for Q1
| and 75th percentile for Q3 as computed using method #10 (listed
| on http://jse.amstat.org/v14n3/langford.html). The "exclusive"
| method uses the median to divide the ordered dataset into two
| halves if the sample is odd, it does not include the median in
| either half - Q1 is then the median of the lower half and Q3
| the median of the upper half. The "inclusive" method also uses
| the median to divide the ordered dataset into two halves but if
| the sample is odd, it includes the median in both halves - Q1
| is then the median of the lower half and Q3 the median of the
| upper half.
|
| The 'quartilemethod' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['linear', 'exclusive', 'inclusive']
|
| Returns
| -------
| Any
|
| scalegroup
| If there are multiple violins that should be sized according to
| to some metric (see `scalemode`), link them by providing a non-
| empty group id here shared by every trace in the same group. If
| a violin's `width` is undefined, `scalegroup` will default to
| the trace's name. In this case, violins with the same names
| will be linked together
|
| The 'scalegroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same (max) width
| "count" means the violins are scaled by the number of sample
| points making up each violin.
|
| The 'scalemode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['width', 'count']
|
| Returns
| -------
| Any
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.violin.selected.Ma
| rker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.violin.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| side
| Determines on which side of the position value the density
| function making up one half of a violin is plotted. Useful when
| comparing two violin traces under "overlay" mode, where one
| trace has `side` set to "positive" and the other to "negative".
|
| The 'side' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['both', 'positive', 'negative']
|
| Returns
| -------
| Any
|
| span
| Sets the span in data space for which the density function will
| be computed. Has an effect only when `spanmode` is set to
| "manual".
|
| The 'span' property is an info array that may be specified as:
|
| * a list or tuple of 2 elements where:
| (0) The 'span[0]' property accepts values of any type
| (1) The 'span[1]' property accepts values of any type
|
| Returns
| -------
| list
|
| spanmode
| Sets the method by which the span in data space where the
| density function will be computed. "soft" means the span goes
| from the sample's minimum value minus two bandwidths to the
| sample's maximum value plus two bandwidths. "hard" means the
| span goes from the sample's minimum to its maximum value. For
| custom span settings, use mode "manual" and fill in the `span`
| attribute.
|
| The 'spanmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['soft', 'hard', 'manual']
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.violin.Stream
|
| text
| Sets the text elements associated with each sample value. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.violin.unselected.
| Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.violin.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the width of the violin in data coordinates. If 0 (default
| value) the width is automatically selected based on the
| positions of other violin traces in the same subplot.
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| x
| Sets the x sample data or coordinates. See overview for more
| info.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Sets the x coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y sample data or coordinates. See overview for more
| info.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Sets the y coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Volume(plotly.basedatatypes.BaseTraceType)
| Volume(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Volume
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Volume object
|
| Draws volume trace between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Volume`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.volume.Caps` instance or
| dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.volume.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.volume.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.volume.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.volume.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.volume.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.volume.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.volume.Slices` instance or
| dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.volume.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.volume.Stream` instance or
| dict with compatible properties
| surface
| :class:`plotly.graph_objects.volume.Surface` instance
| or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Volume
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| caps
| The 'caps' property is an instance of Caps
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Caps`
| - A dict of string/value properties that will be passed
| to the Caps constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.volume.caps.X`
| instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.volume.caps.Y`
| instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.volume.caps.Z`
| instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.volume.Caps
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here `value`) or the bounds set in
| `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as `value` and if set, `cmin` must be set as well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as `value`. Has no effect when `cauto` is `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as `value` and if set, `cmax` must be set as well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.volume.
| colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.volume.colorbar.tickformatstopdefaults), sets
| the default property values to use for elements
| of volume.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.volume.colorbar.Ti
| tle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| volume.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| volume.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.volume.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contour
| The 'contour' property is an instance of Contour
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Contour`
| - A dict of string/value properties that will be passed
| to the Contour constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour lines.
| show
| Sets whether or not dynamic contours are shown
| on hover
| width
| Sets the width of the contour lines.
|
| Returns
| -------
| plotly.graph_objs.volume.Contour
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| flatshading
| Determines whether or not normal smoothing is applied to the
| meshes, creating meshes with an angular, low-poly look via flat
| reflections.
|
| The 'flatshading' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.volume.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| isomax
| Sets the maximum boundary for iso-surface plot.
|
| The 'isomax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| isomin
| Sets the minimum boundary for iso-surface plot.
|
| The 'isomin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.volume.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.volume.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.volume.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| opacityscale
| Sets the opacityscale. The opacityscale must be an array
| containing arrays mapping a normalized value to an opacity
| value. At minimum, a mapping for the lowest (0) and highest (1)
| values are required. For example, `[[0, 1], [0.5, 0.2], [1,
| 1]]` means that higher/lower values would have higher opacity
| values and those in the middle would be more transparent
| Alternatively, `opacityscale` may be a palette name string of
| the following list: 'min', 'max', 'extremes' and 'uniform'. The
| default is 'uniform'.
|
| The 'opacityscale' property accepts values of any type
|
| Returns
| -------
| Any
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| slices
| The 'slices' property is an instance of Slices
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Slices`
| - A dict of string/value properties that will be passed
| to the Slices constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.volume.slices.X`
| instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.volume.slices.Y`
| instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.volume.slices.Z`
| instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.volume.Slices
|
| spaceframe
| The 'spaceframe' property is an instance of Spaceframe
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Spaceframe`
| - A dict of string/value properties that will be passed
| to the Spaceframe constructor
|
| Supported dict properties:
|
| fill
| Sets the fill ratio of the `spaceframe`
| elements. The default fill value is 1 meaning
| that they are entirely shaded. Applying a
| `fill` ratio less than one would allow the
| creation of openings parallel to the edges.
| show
| Displays/hides tetrahedron shapes between
| minimum and maximum iso-values. Often useful
| when either caps or surfaces are disabled or
| filled with values less than 1.
|
| Returns
| -------
| plotly.graph_objs.volume.Spaceframe
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.volume.Stream
|
| surface
| The 'surface' property is an instance of Surface
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Surface`
| - A dict of string/value properties that will be passed
| to the Surface constructor
|
| Supported dict properties:
|
| count
| Sets the number of iso-surfaces between minimum
| and maximum iso-values. By default this value
| is 2 meaning that only minimum and maximum
| surfaces would be drawn.
| fill
| Sets the fill ratio of the iso-surface. The
| default fill value of the surface is 1 meaning
| that they are entirely shaded. On the other
| hand Applying a `fill` ratio less than one
| would allow the creation of openings parallel
| to the edges.
| pattern
| Sets the surface pattern of the iso-surface 3-D
| sections. The default pattern of the surface is
| `all` meaning that the rest of surface elements
| would be shaded. The check options (either 1 or
| 2) could be used to draw half of the squares on
| the surface. Using various combinations of
| capital `A`, `B`, `C`, `D` and `E` may also be
| used to reduce the number of triangles on the
| iso-surfaces and creating other patterns of
| interest.
| show
| Hides/displays surfaces between minimum and
| maximum iso-values.
|
| Returns
| -------
| plotly.graph_objs.volume.Surface
|
| text
| Sets the text elements associated with the vertices. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| value
| Sets the 4th dimension (value) of the vertices.
|
| The 'value' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuehoverformat
| Sets the hover text formatting rulefor `value` using d3
| formatting mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'valuehoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| valuesrc
| Sets the source reference on Chart Studio Cloud for `value`.
|
| The 'valuesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the X coordinates of the vertices on X axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the Y coordinates of the vertices on Y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the Z coordinates of the vertices on Z axis.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Waterfall(plotly.basedatatypes.BaseTraceType)
| Waterfall(arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Waterfall
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Waterfall object
|
| Draws waterfall trace which is useful graph to displays the
| contribution of various elements (either positive or negative)
| in a bar chart. The data visualized by the span of the bars is
| set in `y` if `orientation` is set to "v" (the default) and the
| labels are set in `x`. By setting `orientation` to "h", the
| roles are interchanged.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Waterfall`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units).
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.waterfall.Connector`
| instance or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.waterfall.Decreasing`
| instance or dict with compatible properties
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.waterfall.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta` and `final`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.waterfall.Increasing`
| instance or dict with compatible properties
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.waterfall.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| measure
| An array containing types of values. By default the
| values are considered as 'relative'. However; it is
| possible to use 'total' to compute the sums. Also
| 'absolute' could be applied to reset the computed total
| or to declare an initial value where needed.
| measuresrc
| Sets the source reference on Chart Studio Cloud for
| `measure`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.waterfall.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple waterfalls, totals are
| computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta`, `final` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| totals
| :class:`plotly.graph_objects.waterfall.Totals` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Waterfall
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| base
| Sets where the bar base is drawn (in position axis units).
|
| The 'base' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connector
| The 'connector' property is an instance of Connector
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Connector`
| - A dict of string/value properties that will be passed
| to the Connector constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.waterfall.connecto
| r.Line` instance or dict with compatible
| properties
| mode
| Sets the shape of connector lines.
| visible
| Determines if connector lines are drawn.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Connector
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| decreasing
| The 'decreasing' property is an instance of Decreasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Decreasing`
| - A dict of string/value properties that will be passed
| to the Decreasing constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.waterfall.decreasi
| ng.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.waterfall.Decreasing
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters
| (e.g. 'name+x')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `initial`, `delta` and
| `final`. Anything contained in tag `<extra>` is displayed in
| the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| increasing
| The 'increasing' property is an instance of Increasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Increasing`
| - A dict of string/value properties that will be passed
| to the Increasing constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.waterfall.increasi
| ng.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.waterfall.Increasing
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| measure
| An array containing types of values. By default the values are
| considered as 'relative'. However; it is possible to use
| 'total' to compute the sums. Also 'absolute' could be applied
| to reset the computed total or to declare an initial value
| where needed.
|
| The 'measure' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| measuresrc
| Sets the source reference on Chart Studio Cloud for `measure`.
|
| The 'measuresrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the position where the bar is drawn (in position axis
| units). In "group" barmode, traces that set "offset" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'offset' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetsrc
| Sets the source reference on Chart Studio Cloud for `offset`.
|
| The 'offsetsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the bars. With "v" ("h"), the value of
| the each bar spans along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Outsidetextfont
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the font used for `text`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Textfont
|
| textinfo
| Determines which trace information appear on the graph. In the
| case of having multiple waterfalls, totals are computed
| separately (per trace).
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `initial`,
| `delta`, `final` and `label`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| totals
| The 'totals' property is an instance of Totals
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Totals`
| - A dict of string/value properties that will be passed
| to the Totals constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.waterfall.totals.M
| arker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.waterfall.Totals
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar width (in position axis units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| widthsrc
| Sets the source reference on Chart Studio Cloud for `width`.
|
| The 'widthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class XAxis(builtins.dict)
| XAxis(*args, **kwargs)
|
| plotly.graph_objs.XAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.XAxis
| - plotly.graph_objs.layout.scene.XAxis
|
| Method resolution order:
| XAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.XAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.XAxis
| - plotly.graph_objs.layout.scene.XAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class XBins(builtins.dict)
| XBins(*args, **kwargs)
|
| plotly.graph_objs.XBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.XBins
| - plotly.graph_objs.histogram2d.XBins
|
| Method resolution order:
| XBins
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.XBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.XBins
| - plotly.graph_objs.histogram2d.XBins
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class YAxis(builtins.dict)
| YAxis(*args, **kwargs)
|
| plotly.graph_objs.YAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.YAxis
| - plotly.graph_objs.layout.scene.YAxis
|
| Method resolution order:
| YAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.YAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.YAxis
| - plotly.graph_objs.layout.scene.YAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class YBins(builtins.dict)
| YBins(*args, **kwargs)
|
| plotly.graph_objs.YBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.YBins
| - plotly.graph_objs.histogram2d.YBins
|
| Method resolution order:
| YBins
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.YBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.YBins
| - plotly.graph_objs.histogram2d.YBins
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class ZAxis(builtins.dict)
| ZAxis(*args, **kwargs)
|
| plotly.graph_objs.ZAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.scene.ZAxis
|
| Method resolution order:
| ZAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ZAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.scene.ZAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\graph_objects\__init__.py
plotly.graph_objs
Python Library Documentation: package plotly.graph_objs in plotly
NAME
plotly.graph_objs
PACKAGE CONTENTS
_bar
_barpolar
_box
_candlestick
_carpet
_choropleth
_choroplethmap
_choroplethmapbox
_cone
_contour
_contourcarpet
_densitymap
_densitymapbox
_deprecations
_figure
_figurewidget
_frame
_funnel
_funnelarea
_heatmap
_heatmapgl
_histogram
_histogram2d
_histogram2dcontour
_icicle
_image
_indicator
_isosurface
_layout
_mesh3d
_ohlc
_parcats
_parcoords
_pie
_pointcloud
_sankey
_scatter
_scatter3d
_scattercarpet
_scattergeo
_scattergl
_scattermap
_scattermapbox
_scatterpolar
_scatterpolargl
_scattersmith
_scatterternary
_splom
_streamtube
_sunburst
_surface
_table
_treemap
_violin
_volume
_waterfall
bar (package)
barpolar (package)
box (package)
candlestick (package)
carpet (package)
choropleth (package)
choroplethmap (package)
choroplethmapbox (package)
cone (package)
contour (package)
contourcarpet (package)
densitymap (package)
densitymapbox (package)
funnel (package)
funnelarea (package)
graph_objs
heatmap (package)
heatmapgl (package)
histogram (package)
histogram2d (package)
histogram2dcontour (package)
icicle (package)
image (package)
indicator (package)
isosurface (package)
layout (package)
mesh3d (package)
ohlc (package)
parcats (package)
parcoords (package)
pie (package)
pointcloud (package)
sankey (package)
scatter (package)
scatter3d (package)
scattercarpet (package)
scattergeo (package)
scattergl (package)
scattermap (package)
scattermapbox (package)
scatterpolar (package)
scatterpolargl (package)
scattersmith (package)
scatterternary (package)
splom (package)
streamtube (package)
sunburst (package)
surface (package)
table (package)
treemap (package)
violin (package)
volume (package)
waterfall (package)
CLASSES
builtins.dict(builtins.object)
plotly.graph_objs._deprecations.AngularAxis
plotly.graph_objs._deprecations.Annotation
plotly.graph_objs._deprecations.ColorBar
plotly.graph_objs._deprecations.Contours
plotly.graph_objs._deprecations.ErrorX
plotly.graph_objs._deprecations.ErrorY
plotly.graph_objs._deprecations.ErrorZ
plotly.graph_objs._deprecations.Font
plotly.graph_objs._deprecations.Histogram2dcontour
plotly.graph_objs._deprecations.Legend
plotly.graph_objs._deprecations.Line
plotly.graph_objs._deprecations.Margin
plotly.graph_objs._deprecations.Marker
plotly.graph_objs._deprecations.RadialAxis
plotly.graph_objs._deprecations.Scene
plotly.graph_objs._deprecations.Stream
plotly.graph_objs._deprecations.Trace
plotly.graph_objs._deprecations.XAxis
plotly.graph_objs._deprecations.XBins
plotly.graph_objs._deprecations.YAxis
plotly.graph_objs._deprecations.YBins
plotly.graph_objs._deprecations.ZAxis
builtins.list(builtins.object)
plotly.graph_objs._deprecations.Annotations
plotly.graph_objs._deprecations.Data
plotly.graph_objs._deprecations.Frames
plotly.basedatatypes.BaseFigure(builtins.object)
plotly.graph_objs._figure.Figure
plotly.basedatatypes.BaseFrameHierarchyType(plotly.basedatatypes.BasePlotlyType)
plotly.graph_objs._frame.Frame
plotly.basedatatypes.BaseLayoutType(plotly.basedatatypes.BaseLayoutHierarchyType)
plotly.graph_objs._layout.Layout
plotly.basedatatypes.BaseTraceType(plotly.basedatatypes.BaseTraceHierarchyType)
plotly.graph_objs._bar.Bar
plotly.graph_objs._barpolar.Barpolar
plotly.graph_objs._box.Box
plotly.graph_objs._candlestick.Candlestick
plotly.graph_objs._carpet.Carpet
plotly.graph_objs._choropleth.Choropleth
plotly.graph_objs._choroplethmap.Choroplethmap
plotly.graph_objs._choroplethmapbox.Choroplethmapbox
plotly.graph_objs._cone.Cone
plotly.graph_objs._contour.Contour
plotly.graph_objs._contourcarpet.Contourcarpet
plotly.graph_objs._densitymap.Densitymap
plotly.graph_objs._densitymapbox.Densitymapbox
plotly.graph_objs._funnel.Funnel
plotly.graph_objs._funnelarea.Funnelarea
plotly.graph_objs._heatmap.Heatmap
plotly.graph_objs._heatmapgl.Heatmapgl
plotly.graph_objs._histogram.Histogram
plotly.graph_objs._histogram2d.Histogram2d
plotly.graph_objs._histogram2dcontour.Histogram2dContour
plotly.graph_objs._icicle.Icicle
plotly.graph_objs._image.Image
plotly.graph_objs._indicator.Indicator
plotly.graph_objs._isosurface.Isosurface
plotly.graph_objs._mesh3d.Mesh3d
plotly.graph_objs._ohlc.Ohlc
plotly.graph_objs._parcats.Parcats
plotly.graph_objs._parcoords.Parcoords
plotly.graph_objs._pie.Pie
plotly.graph_objs._pointcloud.Pointcloud
plotly.graph_objs._sankey.Sankey
plotly.graph_objs._scatter.Scatter
plotly.graph_objs._scatter3d.Scatter3d
plotly.graph_objs._scattercarpet.Scattercarpet
plotly.graph_objs._scattergeo.Scattergeo
plotly.graph_objs._scattergl.Scattergl
plotly.graph_objs._scattermap.Scattermap
plotly.graph_objs._scattermapbox.Scattermapbox
plotly.graph_objs._scatterpolar.Scatterpolar
plotly.graph_objs._scatterpolargl.Scatterpolargl
plotly.graph_objs._scattersmith.Scattersmith
plotly.graph_objs._scatterternary.Scatterternary
plotly.graph_objs._splom.Splom
plotly.graph_objs._streamtube.Streamtube
plotly.graph_objs._sunburst.Sunburst
plotly.graph_objs._surface.Surface
plotly.graph_objs._table.Table
plotly.graph_objs._treemap.Treemap
plotly.graph_objs._violin.Violin
plotly.graph_objs._volume.Volume
plotly.graph_objs._waterfall.Waterfall
plotly.basewidget.BaseFigureWidget(plotly.basedatatypes.BaseFigure, ipywidgets.widgets.domwidget.DOMWidget)
plotly.graph_objs._figurewidget.FigureWidget
class AngularAxis(builtins.dict)
| AngularAxis(*args, **kwargs)
|
| plotly.graph_objs.AngularAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.AngularAxis
| - plotly.graph_objs.layout.polar.AngularAxis
|
| Method resolution order:
| AngularAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.AngularAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.AngularAxis
| - plotly.graph_objs.layout.polar.AngularAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Annotation(builtins.dict)
| Annotation(*args, **kwargs)
|
| plotly.graph_objs.Annotation is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| Method resolution order:
| Annotation
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Annotation is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Annotations(builtins.list)
| Annotations(*args, **kwargs)
|
| plotly.graph_objs.Annotations is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| Method resolution order:
| Annotations
| builtins.list
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Annotations is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.layout.Annotation
| - plotly.graph_objs.layout.scene.Annotation
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.list:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.list:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.list:
|
| __new__(*args, **kwargs) class method of builtins.list
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.list:
|
| __hash__ = None
class Bar(plotly.basedatatypes.BaseTraceType)
| Bar(arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Bar
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Bar object
|
| The data visualized by the span of the bars is set in `y` if
| `orientation` is set to "v" (the default) and the labels are
| set in `x`. By setting `orientation` to "h", the roles are
| interchanged.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Bar`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units). In "stack" or "relative" barmode, traces that
| set "base" will be excluded and drawn in "overlay" mode
| instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.bar.ErrorX` instance or
| dict with compatible properties
| error_y
| :class:`plotly.graph_objects.bar.ErrorY` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.bar.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`. Anything contained in
| tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.bar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.bar.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.bar.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.bar.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.bar.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Bar
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| base
| Sets where the bar base is drawn (in position axis units). In
| "stack" or "relative" barmode, traces that set "base" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'base' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| basesrc
| Sets the source reference on Chart Studio Cloud for `base`.
|
| The 'basesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.bar.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.bar.ErrorY
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.bar.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `value` and `label`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.bar.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.bar.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.bar.marker.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| cornerradius
| Sets the rounding of corners. May be an integer
| number of pixels, or a percentage of bar width
| (as a string ending in %). Defaults to
| `layout.barcornerradius`. In stack or relative
| barmode, the first trace to set cornerradius is
| used for the whole stack.
| line
| :class:`plotly.graph_objects.bar.marker.Line`
| instance or dict with compatible properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.bar.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the position where the bar is drawn (in position axis
| units). In "group" barmode, traces that set "offset" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'offset' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetsrc
| Sets the source reference on Chart Studio Cloud for `offset`.
|
| The 'offsetsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the bars. With "v" ("h"), the value of
| the each bar spans along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.bar.Outsidetextfont
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.bar.selected.Marke
| r` instance or dict with compatible properties
| textfont
| :class:`plotly.graph_objects.bar.selected.Textf
| ont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.bar.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.bar.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the font used for `text`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.bar.Textfont
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `value`
| and `label`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.bar.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.bar.unselected.Mar
| ker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.bar.unselected.Tex
| tfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.bar.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar width (in position axis units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| widthsrc
| Sets the source reference on Chart Studio Cloud for `width`.
|
| The 'widthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Barpolar(plotly.basedatatypes.BaseTraceType)
| Barpolar(arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)
|
| Method resolution order:
| Barpolar
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, **kwargs)
| Construct a new Barpolar object
|
| The data visualized by the radial span of the bars is set in
| `r`
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Barpolar`
| base
| Sets where the bar base is drawn (in radial axis
| units). In "stack" barmode, traces that set "base" will
| be excluded and drawn in "overlay" mode instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.barpolar.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.barpolar.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.barpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.barpolar.Stream` instance
| or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.barpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar angular width (in "thetaunit" units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
|
| Returns
| -------
| Barpolar
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| base
| Sets where the bar base is drawn (in radial axis units). In
| "stack" barmode, traces that set "base" will be excluded and
| drawn in "overlay" mode instead.
|
| The 'base' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| basesrc
| Sets the source reference on Chart Studio Cloud for `base`.
|
| The 'basesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dr
| Sets the r coordinate step.
|
| The 'dr' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dtheta
| Sets the theta coordinate step. By default, the `dtheta` step
| equals the subplot's period divided by the length of the `r`
| coordinates.
|
| The 'dtheta' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters
| (e.g. 'r+theta')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.barpolar.marker.Co
| lorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.barpolar.marker.Li
| ne` instance or dict with compatible properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
|
| The 'offset' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| offsetsrc
| Sets the source reference on Chart Studio Cloud for `offset`.
|
| The 'offsetsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| r
| Sets the radial coordinates
|
| The 'r' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| r0
| Alternate to `r`. Builds a linear space of r coordinates. Use
| with `dr` where `r0` is the starting coordinate and `dr` the
| step.
|
| The 'r0' property accepts values of any type
|
| Returns
| -------
| Any
|
| rsrc
| Sets the source reference on Chart Studio Cloud for `r`.
|
| The 'rsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.barpolar.selected.
| Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.barpolar.selected.
| Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.barpolar.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.barpolar.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| polar subplot. If "polar" (the default value), the data refer
| to `layout.polar`. If "polar2", the data refer to
| `layout.polar2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'polar', that may be specified as the string 'polar'
| optionally followed by an integer >= 1
| (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets hover text elements associated with each bar. If a single
| string, the same string appears over all bars. If an array of
| string, the items are mapped in order to the this trace's
| coordinates.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| theta
| Sets the angular coordinates
|
| The 'theta' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the starting
| coordinate and `dtheta` the step.
|
| The 'theta0' property accepts values of any type
|
| Returns
| -------
| Any
|
| thetasrc
| Sets the source reference on Chart Studio Cloud for `theta`.
|
| The 'thetasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| thetaunit
| Sets the unit of input "theta" values. Has an effect only when
| on "linear" angular axes.
|
| The 'thetaunit' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['radians', 'degrees', 'gradians']
|
| Returns
| -------
| Any
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.barpolar.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.barpolar.unselecte
| d.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.barpolar.unselecte
| d.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.barpolar.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar angular width (in "thetaunit" units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| widthsrc
| Sets the source reference on Chart Studio Cloud for `width`.
|
| The 'widthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Box(plotly.basedatatypes.BaseTraceType)
| Box(arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Box
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Box object
|
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2, i.e. the median) is marked by a line
| inside the box. The fences grow outward from the boxes' edges,
| by default they span +/- 1.5 times the interquartile range
| (IQR: Q3-Q1), The sample mean and standard deviation as well as
| notches and the sample, outlier and suspected outliers points
| can be optionally added to the box plot. The values and
| positions corresponding to each boxes can be input using two
| signatures. The first signature expects users to supply the
| sample values in the `y` data array for vertical boxes (`x` for
| horizontal boxes). By supplying an `x` (`y`) array, one box per
| distinct `x` (`y`) value is drawn If no `x` (`y`) list is
| provided, a single box is drawn. In this case, the box is
| positioned with the trace `name` or with `x0` (`y0`) if
| provided. The second signature expects users to supply the
| boxes corresponding Q1, median and Q3 statistics in the `q1`,
| `median` and `q3` data arrays respectively. Other box features
| relying on statistics namely `lowerfence`, `upperfence`,
| `notchspan` can be set directly by the users. To have plotly
| compute them or to show sample points besides the boxes, users
| can set the `y` data array for vertical boxes (`x` for
| horizontal boxes) to a 2D array with the outer length
| corresponding to the number of boxes in the traces and the
| inner length corresponding the sample size.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Box`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| boxmean
| If True, the mean of the box(es)' underlying
| distribution is drawn as a dashed line inside the
| box(es). If "sd" the standard deviation is also drawn.
| Defaults to True when `mean` is set. Defaults to "sd"
| when `sd` is set Otherwise defaults to False.
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the box(es) are shown with no sample
| points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set. Defaults to "all" under the q1/median/q3
| signature. Otherwise defaults to "outliers".
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step for multi-box traces set
| using q1/median/q3.
| dy
| Sets the y coordinate step for multi-box traces set
| using q1/median/q3.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.box.Hoverlabel` instance
| or dict with compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the box(es).
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.box.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.box.Line` instance or dict
| with compatible properties
| lowerfence
| Sets the lower fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `lowerfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the lower as the last sample
| point below 1.5 times the IQR.
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
| marker
| :class:`plotly.graph_objects.box.Marker` instance or
| dict with compatible properties
| mean
| Sets the mean values. There should be as many items as
| the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `mean` is not
| provided but a sample (in `y` or `x`) is set, we
| compute the mean for each box using the sample values.
| meansrc
| Sets the source reference on Chart Studio Cloud for
| `mean`.
| median
| Sets the median values. There should be as many items
| as the number of boxes desired.
| mediansrc
| Sets the source reference on Chart Studio Cloud for
| `median`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For box traces, the name will
| also be used for the position coordinate, if `x` and
| `x0` (`y` and `y0` if horizontal) are missing and the
| position axis is categorical
| notched
| Determines whether or not notches are drawn. Notches
| displays a confidence interval around the median. We
| compute the confidence interval as median +/- 1.57 *
| IQR / sqrt(N), where IQR is the interquartile range and
| N is the sample size. If two boxes' notches do not
| overlap there is 95% confidence their medians differ.
| See https://sites.google.com/site/davidsstatistics/home
| /notched-box-plots for more info. Defaults to False
| unless `notchwidth` or `notchspan` is set.
| notchspan
| Sets the notch span from the boxes' `median` values.
| There should be as many items as the number of boxes
| desired. This attribute has effect only under the
| q1/median/q3 signature. If `notchspan` is not provided
| but a sample (in `y` or `x`) is set, we compute it as
| 1.57 * IQR / sqrt(N), where N is the sample size.
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
| notchwidth
| Sets the width of the notches relative to the box'
| width. For example, with 0, the notches are as wide as
| the box(es).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the box(es). If 0, the sample points are places over
| the center of the box(es). Positive (negative) values
| correspond to positions to the right (left) for
| vertical boxes and above (below) for horizontal boxes
| q1
| Sets the Quartile 1 values. There should be as many
| items as the number of boxes desired.
| q1src
| Sets the source reference on Chart Studio Cloud for
| `q1`.
| q3
| Sets the Quartile 3 values. There should be as many
| items as the number of boxes desired.
| q3src
| Sets the source reference on Chart Studio Cloud for
| `q3`.
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| sd
| Sets the standard deviation values. There should be as
| many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3
| signature. If `sd` is not provided but a sample (in `y`
| or `x`) is set, we compute the standard deviation for
| each box using the sample values.
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to
| be drawn across any stddev range For example 1-stddev,
| 3-stddev, 5-stddev
| sdsrc
| Sets the source reference on Chart Studio Cloud for
| `sd`.
| selected
| :class:`plotly.graph_objects.box.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showwhiskers
| Determines whether or not whiskers are visible.
| Defaults to true for `sizemode` "quartiles", false for
| "sd".
| sizemode
| Sets the upper and lower bound for the boxes quartiles
| means box is drawn between Q1 and Q3 SD means the box
| is drawn between Mean +- Standard Deviation Argument
| sdmultiple (default 1) to scale the box size So it
| could be drawn 1-stddev, 3-stddev etc
| stream
| :class:`plotly.graph_objects.box.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.box.Unselected` instance
| or dict with compatible properties
| upperfence
| Sets the upper fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `upperfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the upper as the last sample
| point above 1.5 times the IQR.
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| width
| Sets the width of the box in data coordinate If 0
| (default value) the width is automatically selected
| based on the positions of other box traces in the same
| subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Box
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| boxmean
| If True, the mean of the box(es)' underlying distribution is
| drawn as a dashed line inside the box(es). If "sd" the standard
| deviation is also drawn. Defaults to True when `mean` is set.
| Defaults to "sd" when `sd` is set Otherwise defaults to False.
|
| The 'boxmean' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, 'sd', False]
|
| Returns
| -------
| Any
|
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier points
| are shown and points either less than 4*Q1-3*Q3 or greater than
| 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all
| sample points are shown If False, only the box(es) are shown
| with no sample points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is set.
| Defaults to "all" under the q1/median/q3 signature. Otherwise
| defaults to "outliers".
|
| The 'boxpoints' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['all', 'outliers', 'suspectedoutliers', False]
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step for multi-box traces set using
| q1/median/q3.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step for multi-box traces set using
| q1/median/q3.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.box.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual boxes or sample
| points or both?
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['boxes', 'points'] joined with '+' characters
| (e.g. 'boxes+points')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| jitter
| Sets the amount of jitter in the sample points drawn. If 0, the
| sample points align along the distribution axis. If 1, the
| sample points are drawn in a random jitter of width equal to
| the width of the box(es).
|
| The 'jitter' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.box.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of line bounding the box(es).
| width
| Sets the width (in px) of line bounding the
| box(es).
|
| Returns
| -------
| plotly.graph_objs.box.Line
|
| lowerfence
| Sets the lower fence values. There should be as many items as
| the number of boxes desired. This attribute has effect only
| under the q1/median/q3 signature. If `lowerfence` is not
| provided but a sample (in `y` or `x`) is set, we compute the
| lower as the last sample point below 1.5 times the IQR.
|
| The 'lowerfence' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
|
| The 'lowerfencesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| line
| :class:`plotly.graph_objects.box.marker.Line`
| instance or dict with compatible properties
| opacity
| Sets the marker opacity.
| outliercolor
| Sets the color of the outlier sample points.
| size
| Sets the marker size (in px).
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
|
| Returns
| -------
| plotly.graph_objs.box.Marker
|
| mean
| Sets the mean values. There should be as many items as the
| number of boxes desired. This attribute has effect only under
| the q1/median/q3 signature. If `mean` is not provided but a
| sample (in `y` or `x`) is set, we compute the mean for each box
| using the sample values.
|
| The 'mean' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| meansrc
| Sets the source reference on Chart Studio Cloud for `mean`.
|
| The 'meansrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| median
| Sets the median values. There should be as many items as the
| number of boxes desired.
|
| The 'median' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| mediansrc
| Sets the source reference on Chart Studio Cloud for `median`.
|
| The 'mediansrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover. For box traces, the name will also be used for
| the position coordinate, if `x` and `x0` (`y` and `y0` if
| horizontal) are missing and the position axis is categorical
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| notched
| Determines whether or not notches are drawn. Notches displays a
| confidence interval around the median. We compute the
| confidence interval as median +/- 1.57 * IQR / sqrt(N), where
| IQR is the interquartile range and N is the sample size. If two
| boxes' notches do not overlap there is 95% confidence their
| medians differ. See
| https://sites.google.com/site/davidsstatistics/home/notched-
| box-plots for more info. Defaults to False unless `notchwidth`
| or `notchspan` is set.
|
| The 'notched' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| notchspan
| Sets the notch span from the boxes' `median` values. There
| should be as many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3 signature. If
| `notchspan` is not provided but a sample (in `y` or `x`) is
| set, we compute it as 1.57 * IQR / sqrt(N), where N is the
| sample size.
|
| The 'notchspan' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
|
| The 'notchspansrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| notchwidth
| Sets the width of the notches relative to the box' width. For
| example, with 0, the notches are as wide as the box(es).
|
| The 'notchwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 0.5]
|
| Returns
| -------
| int|float
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| pointpos
| Sets the position of the sample points in relation to the
| box(es). If 0, the sample points are places over the center of
| the box(es). Positive (negative) values correspond to positions
| to the right (left) for vertical boxes and above (below) for
| horizontal boxes
|
| The 'pointpos' property is a number and may be specified as:
| - An int or float in the interval [-2, 2]
|
| Returns
| -------
| int|float
|
| q1
| Sets the Quartile 1 values. There should be as many items as
| the number of boxes desired.
|
| The 'q1' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| q1src
| Sets the source reference on Chart Studio Cloud for `q1`.
|
| The 'q1src' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| q3
| Sets the Quartile 3 values. There should be as many items as
| the number of boxes desired.
|
| The 'q3' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| q3src
| Sets the source reference on Chart Studio Cloud for `q3`.
|
| The 'q3src' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile for Q1
| and 75th percentile for Q3 as computed using method #10 (listed
| on http://jse.amstat.org/v14n3/langford.html). The "exclusive"
| method uses the median to divide the ordered dataset into two
| halves if the sample is odd, it does not include the median in
| either half - Q1 is then the median of the lower half and Q3
| the median of the upper half. The "inclusive" method also uses
| the median to divide the ordered dataset into two halves but if
| the sample is odd, it includes the median in both halves - Q1
| is then the median of the lower half and Q3 the median of the
| upper half.
|
| The 'quartilemethod' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['linear', 'exclusive', 'inclusive']
|
| Returns
| -------
| Any
|
| sd
| Sets the standard deviation values. There should be as many
| items as the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `sd` is not provided
| but a sample (in `y` or `x`) is set, we compute the standard
| deviation for each box using the sample values.
|
| The 'sd' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to be drawn
| across any stddev range For example 1-stddev, 3-stddev,
| 5-stddev
|
| The 'sdmultiple' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| sdsrc
| Sets the source reference on Chart Studio Cloud for `sd`.
|
| The 'sdsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.box.selected.Marke
| r` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.box.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showwhiskers
| Determines whether or not whiskers are visible. Defaults to
| true for `sizemode` "quartiles", false for "sd".
|
| The 'showwhiskers' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sizemode
| Sets the upper and lower bound for the boxes quartiles means
| box is drawn between Q1 and Q3 SD means the box is drawn
| between Mean +- Standard Deviation Argument sdmultiple (default
| 1) to scale the box size So it could be drawn 1-stddev,
| 3-stddev etc
|
| The 'sizemode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['quartiles', 'sd']
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.box.Stream
|
| text
| Sets the text elements associated with each sample value. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.box.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.box.unselected.Mar
| ker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.box.Unselected
|
| upperfence
| Sets the upper fence values. There should be as many items as
| the number of boxes desired. This attribute has effect only
| under the q1/median/q3 signature. If `upperfence` is not
| provided but a sample (in `y` or `x`) is set, we compute the
| upper as the last sample point above 1.5 times the IQR.
|
| The 'upperfence' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
|
| The 'upperfencesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| whiskerwidth
| Sets the width of the whiskers relative to the box' width. For
| example, with 1, the whiskers are as wide as the box(es).
|
| The 'whiskerwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| width
| Sets the width of the box in data coordinate If 0 (default
| value) the width is automatically selected based on the
| positions of other box traces in the same subplot.
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| x
| Sets the x sample data or coordinates. See overview for more
| info.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Sets the x coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y sample data or coordinates. See overview for more
| info.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Sets the y coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Candlestick(plotly.basedatatypes.BaseTraceType)
| Candlestick(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
|
| Method resolution order:
| Candlestick
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
| Construct a new Candlestick object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Candlestick`
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.candlestick.Decreasing`
| instance or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.candlestick.Hoverlabel`
| instance or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.candlestick.Increasing`
| instance or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.candlestick.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.candlestick.Line` instance
| or dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.candlestick.Stream`
| instance or dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Candlestick
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| close
| Sets the close values.
|
| The 'close' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| closesrc
| Sets the source reference on Chart Studio Cloud for `close`.
|
| The 'closesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| decreasing
| The 'decreasing' property is an instance of Decreasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Decreasing`
| - A dict of string/value properties that will be passed
| to the Decreasing constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the fill color. Defaults to a half-
| transparent variant of the line color, marker
| color, or marker line color, whichever is
| available.
| line
| :class:`plotly.graph_objects.candlestick.decrea
| sing.Line` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.candlestick.Decreasing
|
| high
| Sets the high values.
|
| The 'high' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| highsrc
| Sets the source reference on Chart Studio Cloud for `high`.
|
| The 'highsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
| split
| Show hover information (open, close, high, low)
| in separate labels.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Hoverlabel
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| increasing
| The 'increasing' property is an instance of Increasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Increasing`
| - A dict of string/value properties that will be passed
| to the Increasing constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the fill color. Defaults to a half-
| transparent variant of the line color, marker
| color, or marker line color, whichever is
| available.
| line
| :class:`plotly.graph_objects.candlestick.increa
| sing.Line` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.candlestick.Increasing
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| width
| Sets the width (in px) of line bounding the
| box(es). Note that this style setting can also
| be set per direction via
| `increasing.line.width` and
| `decreasing.line.width`.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Line
|
| low
| Sets the low values.
|
| The 'low' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lowsrc
| Sets the source reference on Chart Studio Cloud for `low`.
|
| The 'lowsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| open
| Sets the open values.
|
| The 'open' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| opensrc
| Sets the source reference on Chart Studio Cloud for `open`.
|
| The 'opensrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.candlestick.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.candlestick.Stream
|
| text
| Sets hover text elements associated with each sample point. If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| this trace's sample points.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| whiskerwidth
| Sets the width of the whiskers relative to the box' width. For
| example, with 1, the whiskers are as wide as the box(es).
|
| The 'whiskerwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| x
| Sets the x coordinates. If absent, linear coordinate will be
| generated.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Carpet(plotly.basedatatypes.BaseTraceType)
| Carpet(arg=None, a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Carpet
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, a0=None, aaxis=None, asrc=None, b=None, b0=None, baxis=None, bsrc=None, carpet=None, cheaterslope=None, color=None, customdata=None, customdatasrc=None, da=None, db=None, font=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Carpet object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Carpet`
| 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
| :class:`plotly.graph_objects.carpet.Aaxis` instance or
| dict with compatible properties
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| A two dimensional array of y coordinates at each carpet
| point.
| b0
| Alternate to `b`. Builds a linear space of a
| coordinates. Use with `db` where `b0` is the starting
| coordinate and `db` the step.
| baxis
| :class:`plotly.graph_objects.carpet.Baxis` instance or
| dict with compatible properties
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| cheaterslope
| The shift applied to each successive row of data in
| creating a cheater plot. Only used if `x` is been
| omitted.
| color
| Sets default for all colors associated with this axis
| all at once: line, font, tick, and grid colors. Grid
| color is lightened by blending this with the plot
| background Individual pieces can override this.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the a coordinate step. See `a0` for more info.
| db
| Sets the b coordinate step. See `b0` for more info.
| font
| The default font used for axis & tick labels on this
| carpet
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.carpet.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| stream
| :class:`plotly.graph_objects.carpet.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| A two dimensional array of x coordinates at each carpet
| point. If omitted, the plot is a cheater plot and the
| xaxis is hidden by default.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| A two dimensional array of y coordinates at each carpet
| point.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Carpet
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| An array containing values of the first parameter value
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| a0
| Alternate to `a`. Builds a linear space of a coordinates. Use
| with `da` where `a0` is the starting coordinate and `da` the
| step.
|
| The 'a0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| aaxis
| The 'aaxis' property is an instance of Aaxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Aaxis`
| - A dict of string/value properties that will be passed
| to the Aaxis constructor
|
| Supported dict properties:
|
| arraydtick
| The stride between grid lines along the axis
| arraytick0
| The starting index of grid lines along the axis
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided, then `autorange` is set to False.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`.
| cheatertype
|
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| dtick
| The stride between grid lines along the axis
| endline
| Determines whether or not a line is drawn at
| along the final value of this axis. If True,
| the end line is drawn on top of the grid lines.
| endlinecolor
| Sets the line color of the end line.
| endlinewidth
| Sets the width (in px) of the end line.
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the axis line color.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the axis line.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| labelpadding
| Extra padding between label and the axis
| labelprefix
| Sets a axis label prefix.
| labelsuffix
| Sets a axis label suffix.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number
| minorgridcolor
| Sets the color of the grid lines.
| minorgridcount
| Sets the number of minor grid ticks per major
| grid tick
| minorgriddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| minorgridwidth
| Sets the width (in px) of the grid lines.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears.
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showticklabels
| Determines whether axis labels are drawn on the
| low side, the high side, both, or neither side
| of the axis.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| smoothing
|
| startline
| Determines whether or not a line is drawn at
| along the starting value of this axis. If True,
| the start line is drawn on top of the grid
| lines.
| startlinecolor
| Sets the line color of the start line.
| startlinewidth
| Sets the width (in px) of the start line.
| tick0
| The starting index of grid lines along the axis
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.carpet.
| aaxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.carpet.aaxis.tickformatstopdefaults), sets
| the default property values to use for elements
| of carpet.aaxis.tickformatstops
| tickmode
|
| tickprefix
| Sets a tick label prefix.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| title
| :class:`plotly.graph_objects.carpet.aaxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use carpet.aaxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleoffset
| Deprecated: Please use
| carpet.aaxis.title.offset instead. An
| additional amount by which to offset the title
| from the tick labels, given in pixels. Note
| that this used to be set by the now deprecated
| `titleoffset` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
|
| Returns
| -------
| plotly.graph_objs.carpet.Aaxis
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| b
| A two dimensional array of y coordinates at each carpet point.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| b0
| Alternate to `b`. Builds a linear space of a coordinates. Use
| with `db` where `b0` is the starting coordinate and `db` the
| step.
|
| The 'b0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| baxis
| The 'baxis' property is an instance of Baxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Baxis`
| - A dict of string/value properties that will be passed
| to the Baxis constructor
|
| Supported dict properties:
|
| arraydtick
| The stride between grid lines along the axis
| arraytick0
| The starting index of grid lines along the axis
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided, then `autorange` is set to False.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`.
| cheatertype
|
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| dtick
| The stride between grid lines along the axis
| endline
| Determines whether or not a line is drawn at
| along the final value of this axis. If True,
| the end line is drawn on top of the grid lines.
| endlinecolor
| Sets the line color of the end line.
| endlinewidth
| Sets the width (in px) of the end line.
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the axis line color.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the axis line.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| labelpadding
| Extra padding between label and the axis
| labelprefix
| Sets a axis label prefix.
| labelsuffix
| Sets a axis label suffix.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number
| minorgridcolor
| Sets the color of the grid lines.
| minorgridcount
| Sets the number of minor grid ticks per major
| grid tick
| minorgriddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| minorgridwidth
| Sets the width (in px) of the grid lines.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears.
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showticklabels
| Determines whether axis labels are drawn on the
| low side, the high side, both, or neither side
| of the axis.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| smoothing
|
| startline
| Determines whether or not a line is drawn at
| along the starting value of this axis. If True,
| the start line is drawn on top of the grid
| lines.
| startlinecolor
| Sets the line color of the start line.
| startlinewidth
| Sets the width (in px) of the start line.
| tick0
| The starting index of grid lines along the axis
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.carpet.
| baxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.carpet.baxis.tickformatstopdefaults), sets
| the default property values to use for elements
| of carpet.baxis.tickformatstops
| tickmode
|
| tickprefix
| Sets a tick label prefix.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| title
| :class:`plotly.graph_objects.carpet.baxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use carpet.baxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleoffset
| Deprecated: Please use
| carpet.baxis.title.offset instead. An
| additional amount by which to offset the title
| from the tick labels, given in pixels. Note
| that this used to be set by the now deprecated
| `titleoffset` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
|
| Returns
| -------
| plotly.graph_objs.carpet.Baxis
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| carpet
| An identifier for this carpet, so that `scattercarpet` and
| `contourcarpet` traces can specify a carpet plot on which they
| lie
|
| The 'carpet' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cheaterslope
| The shift applied to each successive row of data in creating a
| cheater plot. Only used if `x` is been omitted.
|
| The 'cheaterslope' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| color
| Sets default for all colors associated with this axis all at
| once: line, font, tick, and grid colors. Grid color is
| lightened by blending this with the plot background Individual
| pieces can override this.
|
| The 'color' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| da
| Sets the a coordinate step. See `a0` for more info.
|
| The 'da' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| db
| Sets the b coordinate step. See `b0` for more info.
|
| The 'db' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| font
| The default font used for axis & tick labels on this carpet
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.carpet.Font
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.carpet.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.carpet.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.carpet.Stream
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| A two dimensional array of x coordinates at each carpet point.
| If omitted, the plot is a cheater plot and the xaxis is hidden
| by default.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| A two dimensional array of y coordinates at each carpet point.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Choropleth(plotly.basedatatypes.BaseTraceType)
| Choropleth(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Choropleth
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Choropleth object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Choropleth`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choropleth.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choropleth.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choropleth.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choropleth.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choropleth.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choropleth.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choropleth.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Choropleth
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.choropl
| eth.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.choropleth.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of choropleth.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.choropleth.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| choropleth.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| choropleth.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.choropleth.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Only has an effect
| when `geojson` is set. Support nested property, for example
| "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| geo
| Sets a reference between this trace's geospatial coordinates
| and a geographic map. If "geo" (the default value), the
| geospatial coordinates refer to `layout.geo`. If "geo2", the
| geospatial coordinates refer to `layout.geo2`, and so on.
|
| The 'geo' property is an identifier of a particular
| subplot, of type 'geo', that may be specified as the string 'geo'
| optionally followed by an integer >= 1
| (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.)
|
| Returns
| -------
| str
|
| geojson
| Sets optional GeoJSON data associated with this trace. If not
| given, the features on the base map are used. It can be set as
| a valid GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or "Feature" with
| geometries of type "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'location+z')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| locationmode
| Determines the set of locations used to match entries in
| `locations` to regions on the map. Values "ISO-3", "USA-
| states", *country names* correspond to features on the base map
| and value "geojson-id" corresponds to features from a custom
| GeoJSON linked to the `geojson` attribute.
|
| The 'locationmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['ISO-3', 'USA-states', 'country names', 'geojson-id']
|
| Returns
| -------
| Any
|
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.choropleth.marker.
| Line` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the locations.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choropleth.selecte
| d.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choropleth.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.choropleth.Stream
|
| text
| Sets the text elements associated with each location.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choropleth.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choropleth.unselec
| ted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choropleth.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the color values.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Choroplethmap(plotly.basedatatypes.BaseTraceType)
| Choroplethmap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Choroplethmap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Choroplethmap object
|
| GeoJSON features to be filled are set in `geojson` The data
| that describes the choropleth value-to-color mapping is set in
| `locations` and `z`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Choroplethmap`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmap traces are placed above the water layers.
| If set to '', the layer will be inserted above every
| existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmap.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Choroplethmap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the choropleth polygons will be inserted before
| the layer with the specified ID. By default, choroplethmap
| traces are placed above the water layers. If set to '', the
| layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.choropl
| ethmap.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.choroplethmap.colorbar.tickformatstopdefaults
| ), sets the default property values to use for
| elements of
| choroplethmap.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.choroplethmap.colo
| rbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| choroplethmap.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| choroplethmap.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Support nested
| property, for example "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| geojson
| Sets the GeoJSON data associated with this trace. It can be set
| as a valid GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or "Feature" with
| geometries of type "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'location+z')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `properties` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| locations
| Sets which features found in "geojson" to plot using their
| feature `id` field.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.choroplethmap.mark
| er.Line` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the locations.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmap.sele
| cted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| map subplot. If "map" (the default value), the data refer to
| `layout.map`. If "map2", the data refer to `layout.map2`, and
| so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'map', that may be specified as the string 'map'
| optionally followed by an integer >= 1
| (e.g. 'map', 'map1', 'map2', 'map3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets the text elements associated with each location.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmap.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmap.unse
| lected.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmap.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the color values.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Choroplethmapbox(plotly.basedatatypes.BaseTraceType)
| Choroplethmapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Choroplethmapbox
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Choroplethmapbox object
|
| "choroplethmapbox" trace is deprecated! Please consider
| switching to the "choroplethmap" trace type and `map` subplots.
| Learn more at: https://plotly.com/javascript/maplibre-
| migration/ GeoJSON features to be filled are set in `geojson`
| The data that describes the choropleth value-to-color mapping
| is set in `locations` and `z`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Choroplethmapbox`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmapbox traces are placed above the water
| layers. If set to '', the layer will be inserted above
| every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
| l` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmapbox.Legendgro
| uptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmapbox.Unselecte
| d` instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Choroplethmapbox
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the choropleth polygons will be inserted before
| the layer with the specified ID. By default, choroplethmapbox
| traces are placed above the water layers. If set to '', the
| layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.choropl
| ethmapbox.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.choroplethmapbox.colorbar.tickformatstopdefau
| lts), sets the default property values to use
| for elements of
| choroplethmapbox.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.choroplethmapbox.c
| olorbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| choroplethmapbox.colorbar.title.font instead.
| Sets this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| choroplethmapbox.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Support nested
| property, for example "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| geojson
| Sets the GeoJSON data associated with this trace. It can be set
| as a valid GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or "Feature" with
| geometries of type "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'location+z')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `properties` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| locations
| Sets which features found in "geojson" to plot using their
| feature `id` field.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.choroplethmapbox.m
| arker.Line` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the locations.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmapbox.s
| elected.Marker` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Stream
|
| subplot
| mapbox subplots and traces are deprecated! Please consider
| switching to `map` subplots and traces. Learn more at:
| https://plotly.com/javascript/maplibre-migration/ Sets a
| reference between this trace's data coordinates and a mapbox
| subplot. If "mapbox" (the default value), the data refer to
| `layout.mapbox`. If "mapbox2", the data refer to
| `layout.mapbox2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'mapbox', that may be specified as the string 'mapbox'
| optionally followed by an integer >= 1
| (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets the text elements associated with each location.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.choroplethmapbox.u
| nselected.Marker` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.choroplethmapbox.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the color values.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class ColorBar(builtins.dict)
| ColorBar(*args, **kwargs)
|
| plotly.graph_objs.ColorBar is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.marker.ColorBar
| - plotly.graph_objs.surface.ColorBar
| - etc.
|
| Method resolution order:
| ColorBar
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ColorBar is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.marker.ColorBar
| - plotly.graph_objs.surface.ColorBar
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Cone(plotly.basedatatypes.BaseTraceType)
| Cone(arg=None, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Cone
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Cone object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Cone`
| anchor
| Sets the cones' anchor with respect to their x/y/z
| positions. Note that "cm" denote the cone's center of
| mass which corresponds to 1/4 from the tail to tip.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.cone.ColorBar` instance or
| dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.cone.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `norm` Anything contained in tag `<extra>`
| is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.cone.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.cone.Lighting` instance or
| dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.cone.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in
| the vector field) or as "absolute" value (in the same
| units as the vector field). To display sizes in actual
| vector length use "raw".
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally)
| corresponds to the minimum "time" to travel across two
| successive x/y/z positions at the average velocity of
| those two successive positions. All cones in a given
| trace use the same factor. With `sizemode` set to
| "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is
| 0.5. With `sizemode` set to "absolute", `sizeref` has
| the same units as the u/v/w vector field, its the
| default value is half the sample's maximum vector norm.
| stream
| :class:`plotly.graph_objects.cone.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the cones. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Cone
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| anchor
| Sets the cones' anchor with respect to their x/y/z positions.
| Note that "cm" denote the cone's center of mass which
| corresponds to 1/4 from the tail to tip.
|
| The 'anchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['tip', 'tail', 'cm', 'center']
|
| Returns
| -------
| Any
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here u/v/w norm) or the bounds set
| in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmin` must be set as
| well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as u/v/w norm. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmax` must be set as
| well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.cone.co
| lorbar.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.cone.colorbar.tickformatstopdefaults), sets
| the default property values to use for elements
| of cone.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.cone.colorbar.Titl
| e` instance or dict with compatible properties
| titlefont
| Deprecated: Please use cone.colorbar.title.font
| instead. Sets this color bar's title font. Note
| that the title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use cone.colorbar.title.side
| instead. Determines the location of color bar's
| title with respect to the color bar. Defaults
| to "top" when `orientation` if "v" and
| defaults to "right" when `orientation` if "h".
| Note that the title's location used to be set
| by the now deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.cone.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.cone.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `norm` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.cone.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.cone.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.cone.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in the
| vector field) or as "absolute" value (in the same units as the
| vector field). To display sizes in actual vector length use
| "raw".
|
| The 'sizemode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['scaled', 'absolute', 'raw']
|
| Returns
| -------
| Any
|
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally) corresponds to the
| minimum "time" to travel across two successive x/y/z positions
| at the average velocity of those two successive positions. All
| cones in a given trace use the same factor. With `sizemode` set
| to "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is 0.5. With
| `sizemode` set to "absolute", `sizeref` has the same units as
| the u/v/w vector field, its the default value is half the
| sample's maximum vector norm.
|
| The 'sizeref' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.cone.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.cone.Stream
|
| text
| Sets the text elements associated with the cones. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| u
| Sets the x components of the vector field.
|
| The 'u' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'uhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| usrc
| Sets the source reference on Chart Studio Cloud for `u`.
|
| The 'usrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| v
| Sets the y components of the vector field.
|
| The 'v' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'vhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| vsrc
| Sets the source reference on Chart Studio Cloud for `v`.
|
| The 'vsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| w
| Sets the z components of the vector field.
|
| The 'w' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| whoverformat
| Sets the hover text formatting rulefor `w` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'whoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| wsrc
| Sets the source reference on Chart Studio Cloud for `w`.
|
| The 'wsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates of the vector field and of the displayed
| cones.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates of the vector field and of the displayed
| cones.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates of the vector field and of the displayed
| cones.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Contour(plotly.basedatatypes.BaseTraceType)
| Contour(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Contour
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
| Construct a new Contour object
|
| The data from which contour lines are computed is set in `z`.
| Data in `z` must be a 2D list of numbers. Say that `z` has N
| rows and M columns, then by default, these N rows correspond to
| N y coordinates (set in `y` or auto-generated) and the M
| columns correspond to M x coordinates (set in `x` or auto-
| generated). By setting `transpose` to True, the above behavior
| is flipped.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Contour`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contour.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array otherwise it
| is defaulted to false.
| contours
| :class:`plotly.graph_objects.contour.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.contour.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contour.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contour.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contour.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Contour
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocontour
| Determines whether or not the contour level attributes are
| picked by an algorithm. If True, the number of contour levels
| can be set in `ncontours`. If False, set the contour level
| attributes in `contours`.
|
| The 'autocontour' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.contour
| .colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.contour.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of contour.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.contour.colorbar.T
| itle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| contour.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| contour.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.contour.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data are filled in. It is defaulted to true if `z`
| is a one dimensional array otherwise it is defaulted to false.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| coloring
| Determines the coloring method showing the
| contour values. If "fill", coloring is done
| evenly between each contour level If "heatmap",
| a heatmap gradient coloring is applied between
| each contour level. If "lines", coloring is
| done on the contour lines. If "none", no
| coloring is applied on this trace.
| end
| Sets the end contour level value. Must be more
| than `contours.start`
| labelfont
| Sets the font used for labeling the contour
| levels. The default color comes from the lines,
| if shown. The default family and size come from
| `layout.font`.
| labelformat
| Sets the contour label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| operation
| Sets the constraint operation. "=" keeps
| regions equal to `value` "<" and "<=" keep
| regions less than `value` ">" and ">=" keep
| regions greater than `value` "[]", "()", "[)",
| and "(]" keep regions inside `value[0]` to
| `value[1]` "][", ")(", "](", ")[" keep regions
| outside `value[0]` to value[1]` Open vs. closed
| intervals make no difference to constraint
| display, but all versions are allowed for
| consistency with filter transforms.
| showlabels
| Determines whether to label the contour lines
| with their values.
| showlines
| Determines whether or not the contour lines are
| drawn. Has an effect only if
| `contours.coloring` is set to "fill".
| size
| Sets the step between each contour level. Must
| be positive.
| start
| Sets the starting contour level value. Must be
| less than `contours.end`
| type
| If `levels`, the data is represented as a
| contour plot with multiple levels displayed. If
| `constraint`, the data is represented as
| constraints with the invalid region shaded as
| specified by the `operation` and `value`
| parameters.
| value
| Sets the value or values of the constraint
| boundary. When `operation` is set to one of the
| comparison values (=,<,>=,>,<=) "value" is
| expected to be a number. When `operation` is
| set to one of the interval values
| ([],(),[),(],][,)(,](,)[) "value" is expected
| to be an array of two numbers where the first
| is the lower bound and the second is the upper
| bound.
|
| Returns
| -------
| plotly.graph_objs.contour.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line color,
| marker color, or marker line color, whichever is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
| - A number that will be interpreted as a color
| according to contour.colorscale
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.contour.Hoverlabel
|
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data have hover labels associated with them.
|
| The 'hoverongaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.contour.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour level. Has no
| effect if `contours.coloring` is set to
| "lines".
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| smoothing
| Sets the amount of smoothing for the contour
| lines, where 0 corresponds to no smoothing.
| width
| Sets the contour line width in (in px) Defaults
| to 0.5 when `contours.type` is "levels".
| Defaults to 2 when `contour.type` is
| "constraint".
|
| Returns
| -------
| plotly.graph_objs.contour.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ncontours
| Sets the maximum number of contour levels. The actual number of
| contours will be chosen automatically to be less than or equal
| to the value of `ncontours`. Has an effect only if
| `autocontour` is True or if `contours.size` is missing.
|
| The 'ncontours' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [1, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.contour.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contour.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.contour.Textfont
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Template string used for rendering the information
| text that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable}, for
| example "y: %{y}". Numbers are formatted using d3-format's
| syntax %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `x`, `y`,
| `z` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xtype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'xtype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ytype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'ytype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Contourcarpet(plotly.basedatatypes.BaseTraceType)
| Contourcarpet(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Contourcarpet
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)
| Construct a new Contourcarpet object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Contourcarpet`
| a
| Sets the x coordinates.
| a0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| atype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| b
| Sets the y coordinates.
| b0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| btype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| carpet
| The `carpet` of the carpet axes on which this contour
| trace lies
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contourcarpet.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.contourcarpet.Contours`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the x coordinate step. See `x0` for more info.
| db
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contourcarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contourcarpet.Line`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contourcarpet.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Contourcarpet
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| Sets the x coordinates.
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| a0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'a0' property accepts values of any type
|
| Returns
| -------
| Any
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| atype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'atype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocontour
| Determines whether or not the contour level attributes are
| picked by an algorithm. If True, the number of contour levels
| can be set in `ncontours`. If False, set the contour level
| attributes in `contours`.
|
| The 'autocontour' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| b
| Sets the y coordinates.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| b0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'b0' property accepts values of any type
|
| Returns
| -------
| Any
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| btype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'btype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| carpet
| The `carpet` of the carpet axes on which this contour trace
| lies
|
| The 'carpet' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.contour
| carpet.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.contourcarpet.colorbar.tickformatstopdefaults
| ), sets the default property values to use for
| elements of
| contourcarpet.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.contourcarpet.colo
| rbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| contourcarpet.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| contourcarpet.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| coloring
| Determines the coloring method showing the
| contour values. If "fill", coloring is done
| evenly between each contour level If "lines",
| coloring is done on the contour lines. If
| "none", no coloring is applied on this trace.
| end
| Sets the end contour level value. Must be more
| than `contours.start`
| labelfont
| Sets the font used for labeling the contour
| levels. The default color comes from the lines,
| if shown. The default family and size come from
| `layout.font`.
| labelformat
| Sets the contour label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| operation
| Sets the constraint operation. "=" keeps
| regions equal to `value` "<" and "<=" keep
| regions less than `value` ">" and ">=" keep
| regions greater than `value` "[]", "()", "[)",
| and "(]" keep regions inside `value[0]` to
| `value[1]` "][", ")(", "](", ")[" keep regions
| outside `value[0]` to value[1]` Open vs. closed
| intervals make no difference to constraint
| display, but all versions are allowed for
| consistency with filter transforms.
| showlabels
| Determines whether to label the contour lines
| with their values.
| showlines
| Determines whether or not the contour lines are
| drawn. Has an effect only if
| `contours.coloring` is set to "fill".
| size
| Sets the step between each contour level. Must
| be positive.
| start
| Sets the starting contour level value. Must be
| less than `contours.end`
| type
| If `levels`, the data is represented as a
| contour plot with multiple levels displayed. If
| `constraint`, the data is represented as
| constraints with the invalid region shaded as
| specified by the `operation` and `value`
| parameters.
| value
| Sets the value or values of the constraint
| boundary. When `operation` is set to one of the
| comparison values (=,<,>=,>,<=) "value" is
| expected to be a number. When `operation` is
| set to one of the interval values
| ([],(),[),(],][,)(,](,)[) "value" is expected
| to be an array of two numbers where the first
| is the lower bound and the second is the upper
| bound.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| da
| Sets the x coordinate step. See `x0` for more info.
|
| The 'da' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| db
| Sets the y coordinate step. See `y0` for more info.
|
| The 'db' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line color,
| marker color, or marker line color, whichever is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
| - A number that will be interpreted as a color
| according to contourcarpet.colorscale
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour level. Has no
| effect if `contours.coloring` is set to
| "lines".
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| smoothing
| Sets the amount of smoothing for the contour
| lines, where 0 corresponds to no smoothing.
| width
| Sets the contour line width in (in px) Defaults
| to 0.5 when `contours.type` is "levels".
| Defaults to 2 when `contour.type` is
| "constraint".
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ncontours
| Sets the maximum number of contour levels. The actual number of
| contours will be chosen automatically to be less than or equal
| to the value of `ncontours`. Has an effect only if
| `autocontour` is True or if `contours.size` is missing.
|
| The 'ncontours' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [1, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.contourcarpet.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.contourcarpet.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Contours(builtins.dict)
| Contours(*args, **kwargs)
|
| plotly.graph_objs.Contours is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.contour.Contours
| - plotly.graph_objs.surface.Contours
| - etc.
|
| Method resolution order:
| Contours
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Contours is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.contour.Contours
| - plotly.graph_objs.surface.Contours
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Data(builtins.list)
| Data(*args, **kwargs)
|
| plotly.graph_objs.Data is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| Method resolution order:
| Data
| builtins.list
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Data is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.list:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.list:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.list:
|
| __new__(*args, **kwargs) class method of builtins.list
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.list:
|
| __hash__ = None
class Densitymap(plotly.basedatatypes.BaseTraceType)
| Densitymap(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Densitymap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Densitymap object
|
| Draws a bivariate kernel density estimation with a Gaussian
| kernel from `lon` and `lat` coordinates and optional `z` values
| using a colorscale.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Densitymap`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymap trace will be inserted
| before the layer with the specified ID. By default,
| densitymap traces are placed below the first layer of
| type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymap
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Densitymap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the densitymap trace will be inserted before the
| layer with the specified ID. By default, densitymap traces are
| placed below the first layer of type symbol If set to '', the
| layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.density
| map.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.densitymap.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of densitymap.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.densitymap.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| densitymap.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| densitymap.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.densitymap.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.densitymap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.densitymap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| radius
| Sets the radius of influence of one `lon` / `lat` point in
| pixels. Increasing the value makes the densitymap trace
| smoother, but less detailed.
|
| The 'radius' property is a number and may be specified as:
| - An int or float in the interval [1, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| radiussrc
| Sets the source reference on Chart Studio Cloud for `radius`.
|
| The 'radiussrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.densitymap.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| map subplot. If "map" (the default value), the data refer to
| `layout.map`. If "map2", the data refer to `layout.map2`, and
| so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'map', that may be specified as the string 'map'
| optionally followed by an integer >= 1
| (e.g. 'map', 'map1', 'map2', 'map3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the points' weight. For example, a value of 10 would be
| equivalent to having 10 points of weight 1 in the same spot
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Densitymapbox(plotly.basedatatypes.BaseTraceType)
| Densitymapbox(arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Densitymapbox
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Densitymapbox object
|
| "densitymapbox" trace is deprecated! Please consider switching
| to the "densitymap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ Draws a
| bivariate kernel density estimation with a Gaussian kernel from
| `lon` and `lat` coordinates and optional `z` values using a
| colorscale.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Densitymapbox`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymapbox trace will be inserted
| before the layer with the specified ID. By default,
| densitymapbox traces are placed below the first layer
| of type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymapbox
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Densitymapbox
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| below
| Determines if the densitymapbox trace will be inserted before
| the layer with the specified ID. By default, densitymapbox
| traces are placed below the first layer of type symbol If set
| to '', the layer will be inserted above every existing layer.
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.density
| mapbox.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.densitymapbox.colorbar.tickformatstopdefaults
| ), sets the default property values to use for
| elements of
| densitymapbox.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.densitymapbox.colo
| rbar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| densitymapbox.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| densitymapbox.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| radius
| Sets the radius of influence of one `lon` / `lat` point in
| pixels. Increasing the value makes the densitymapbox trace
| smoother, but less detailed.
|
| The 'radius' property is a number and may be specified as:
| - An int or float in the interval [1, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| radiussrc
| Sets the source reference on Chart Studio Cloud for `radius`.
|
| The 'radiussrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.densitymapbox.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.densitymapbox.Stream
|
| subplot
| mapbox subplots and traces are deprecated! Please consider
| switching to `map` subplots and traces. Learn more at:
| https://plotly.com/javascript/maplibre-migration/ Sets a
| reference between this trace's data coordinates and a mapbox
| subplot. If "mapbox" (the default value), the data refer to
| `layout.mapbox`. If "mapbox2", the data refer to
| `layout.mapbox2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'mapbox', that may be specified as the string 'mapbox'
| optionally followed by an integer >= 1
| (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| z
| Sets the points' weight. For example, a value of 10 would be
| equivalent to having 10 points of weight 1 in the same spot
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class ErrorX(builtins.dict)
| ErrorX(*args, **kwargs)
|
| plotly.graph_objs.ErrorX is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorX
| - plotly.graph_objs.histogram.ErrorX
| - etc.
|
| Method resolution order:
| ErrorX
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ErrorX is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorX
| - plotly.graph_objs.histogram.ErrorX
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class ErrorY(builtins.dict)
| ErrorY(*args, **kwargs)
|
| plotly.graph_objs.ErrorY is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorY
| - plotly.graph_objs.histogram.ErrorY
| - etc.
|
| Method resolution order:
| ErrorY
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ErrorY is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.ErrorY
| - plotly.graph_objs.histogram.ErrorY
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class ErrorZ(builtins.dict)
| ErrorZ(*args, **kwargs)
|
| plotly.graph_objs.ErrorZ is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter3d.ErrorZ
|
| Method resolution order:
| ErrorZ
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ErrorZ is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter3d.ErrorZ
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Figure(plotly.basedatatypes.BaseFigure)
| Figure(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
|
| Method resolution order:
| Figure
| plotly.basedatatypes.BaseFigure
| builtins.object
|
| Methods defined here:
|
| __init__(self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
| Create a new :class:Figure 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 single trace instance
| (e.g. Scatter(...), Bar(...), etc.)
| - A list or tuple of dicts of string/value properties where:
| - The 'type' property specifies the trace type
| One of: ['bar', 'barpolar', 'box', 'candlestick',
| 'carpet', 'choropleth', 'choroplethmap',
| 'choroplethmapbox', 'cone', 'contour',
| 'contourcarpet', 'densitymap',
| 'densitymapbox', 'funnel', 'funnelarea',
| 'heatmap', 'heatmapgl', 'histogram',
| 'histogram2d', 'histogram2dcontour', 'icicle',
| 'image', 'indicator', 'isosurface', 'mesh3d',
| 'ohlc', 'parcats', 'parcoords', 'pie',
| 'pointcloud', 'sankey', 'scatter',
| 'scatter3d', 'scattercarpet', 'scattergeo',
| 'scattergl', 'scattermap', 'scattermapbox',
| 'scatterpolar', 'scatterpolargl',
| 'scattersmith', 'scatterternary', 'splom',
| 'streamtube', 'sunburst', 'surface', 'table',
| 'treemap', 'violin', 'volume', 'waterfall']
|
| - 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 :class:`plotly.graph_objs.Layout`
| - A dict of string/value properties that will be passed
| to the Layout constructor
|
| Supported dict properties:
|
| activeselection
| :class:`plotly.graph_objects.layout.Activeselec
| tion` instance or dict with compatible
| properties
| activeshape
| :class:`plotly.graph_objects.layout.Activeshape
| ` instance or dict with compatible properties
| annotations
| A tuple of
| :class:`plotly.graph_objects.layout.Annotation`
| instances or dicts with compatible properties
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults),
| sets the default property values to use for
| elements of layout.annotations
| 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.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. This is the default value;
| however it could be overridden for individual
| axes.
| barcornerradius
| Sets the rounding of bar corners. May be an
| integer number of pixels, or a percentage of
| bar width (as a string ending in %).
| 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 reduce "opacity" to
| see multiple bars.
| barnorm
| Sets the normalization for bar traces on the
| graph. With "fraction", the value of each bar
| is divided by the sum of all values at that
| location coordinate. "percent" is the same but
| multiplied by 100 to show percentages.
| boxgap
| Sets the gap (in plot fraction) between boxes
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| boxmode
| Determines how boxes at the same location
| coordinate are displayed on the graph. If
| "group", the boxes are plotted next to one
| another centered around the shared location. If
| "overlay", the boxes are plotted over one
| another, you might need to set "opacity" to see
| them multiple boxes. Has no effect on traces
| that have "width" set.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout
| the plot.
| clickmode
| Determines the mode of single click
| interactions. "event" is the default value and
| emits the `plotly_click` event. In addition
| this mode emits the `plotly_selected` event in
| drag modes "lasso" and "select", but with no
| event data attached (kept for compatibility
| reasons). The "select" flag enables selecting
| single data points via click. This mode also
| supports persistent selections, meaning that
| pressing Shift while clicking, adds to /
| subtracts from an existing selection. "select"
| with `hovermode`: "x" can be confusing,
| consider explicitly setting `hovermode`:
| "closest" when using this feature. Selection
| events are sent accordingly as long as "event"
| flag is set as well. When the "event" flag is
| missing, `plotly_click` and `plotly_selected`
| events are not fired.
| coloraxis
| :class:`plotly.graph_objects.layout.Coloraxis`
| instance or dict with compatible properties
| colorscale
| :class:`plotly.graph_objects.layout.Colorscale`
| instance or dict with compatible properties
| colorway
| Sets the default trace colors.
| computed
| Placeholder for exporting automargin-impacting
| values namely `margin.t`, `margin.b`,
| `margin.l` and `margin.r` in "full-json" mode.
| 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.
| 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.
| editrevision
| Controls persistence of user-driven changes in
| `editable: true` configuration, other than
| trace names and axis titles. Defaults to
| `layout.uirevision`.
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether
| given by `funnelareacolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendiciclecolors
| If `true`, the icicle slice colors (whether
| given by `iciclecolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendpiecolors
| If `true`, the pie slice colors (whether given
| by `piecolorway` or inherited from `colorway`)
| will be extended to three times its original
| length by first repeating every color 20%
| lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether
| given by `sunburstcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendtreemapcolors
| If `true`, the treemap slice colors (whether
| given by `treemapcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| font
| Sets the global font. Note that fonts used in
| traces and other layout components inherit from
| the global font.
| funnelareacolorway
| Sets the default funnelarea slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendfunnelareacolors`.
| funnelgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| funnelmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "stack", the bars are stacked on top of one
| another With "group", the bars are plotted next
| to one another centered around the shared
| location. With "overlay", the bars are plotted
| over one another, you might need to reduce
| "opacity" to see multiple bars.
| geo
| :class:`plotly.graph_objects.layout.Geo`
| instance or dict with compatible properties
| grid
| :class:`plotly.graph_objects.layout.Grid`
| instance or dict with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart
| analog of visible:'legendonly' but it can
| contain many labels, and can simultaneously
| hide slices from several pies/funnelarea charts
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud
| 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 Chart Studio Cloud (at
| https://chart-studio.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
| :class:`plotly.graph_objects.layout.Hoverlabel`
| instance or dict with compatible properties
| hovermode
| Determines the mode of hover interactions. If
| "closest", a single hoverlabel will appear for
| the "closest" point within the `hoverdistance`.
| If "x" (or "y"), multiple hoverlabels will
| appear for multiple points at the "closest" x-
| (or y-) coordinate within the `hoverdistance`,
| with the caveat that no more than one
| hoverlabel will appear per trace. If *x
| unified* (or *y unified*), a single hoverlabel
| will appear multiple points at the closest x-
| (or y-) coordinate within the `hoverdistance`
| with the caveat that no more than one
| hoverlabel will appear per trace. In this mode,
| spikelines are enabled by default perpendicular
| to the specified axis. If false, hover
| interactions are disabled.
| hoversubplots
| Determines expansion of hover effects to other
| subplots If "single" just the axis pair of the
| primary point is included without overlaying
| subplots. If "overlaying" all subplots using
| the main axis and occupying the same space are
| included. If "axis", also include stacked
| subplots using the same axis when `hovermode`
| is set to "x", *x unified*, "y" or *y unified*.
| iciclecolorway
| Sets the default icicle slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendiciclecolors`.
| images
| A tuple of
| :class:`plotly.graph_objects.layout.Image`
| instances or dicts with compatible properties
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the
| default property values to use for elements of
| layout.images
| legend
| :class:`plotly.graph_objects.layout.Legend`
| instance or dict with compatible properties
| map
| :class:`plotly.graph_objects.layout.Map`
| instance or dict with compatible properties
| mapbox
| :class:`plotly.graph_objects.layout.Mapbox`
| instance or dict with compatible properties
| margin
| :class:`plotly.graph_objects.layout.Margin`
| instance or dict with compatible properties
| meta
| Assigns extra meta information that can be used
| in various `text` attributes. Attributes such
| as the graph, axis and colorbar `title.text`,
| annotation `text` `trace.name` in legend items,
| `rangeselector`, `updatemenus` and `sliders`
| `label` text all support `meta`. One can access
| `meta` fields using template strings:
| `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an
| object for example `{key: value}` which can be
| accessed %{meta[key]}.
| metasrc
| Sets the source reference on Chart Studio Cloud
| for `meta`.
| minreducedheight
| Minimum height of the plot with
| margin.automargin applied (in px)
| minreducedwidth
| Minimum width of the plot with
| margin.automargin applied (in px)
| modebar
| :class:`plotly.graph_objects.layout.Modebar`
| instance or dict with compatible properties
| newselection
| :class:`plotly.graph_objects.layout.Newselectio
| n` instance or dict with compatible properties
| newshape
| :class:`plotly.graph_objects.layout.Newshape`
| instance or dict with compatible properties
| paper_bgcolor
| Sets the background color of the paper where
| the graph is drawn.
| piecolorway
| Sets the default pie slice colors. Defaults to
| the main `colorway` used for trace colors. If
| you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendpiecolors`.
| plot_bgcolor
| Sets the background color of the plotting area
| in-between x and y axes.
| polar
| :class:`plotly.graph_objects.layout.Polar`
| instance or dict with compatible properties
| scattergap
| Sets the gap (in plot fraction) between scatter
| points of adjacent location coordinates.
| Defaults to `bargap`.
| scattermode
| Determines how scatter points at the same
| location coordinate are displayed on the graph.
| With "group", the scatter points are plotted
| next to one another centered around the shared
| location. With "overlay", the scatter points
| are plotted over one another, you might need to
| reduce "opacity" to see multiple scatter
| points.
| scene
| :class:`plotly.graph_objects.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.
| selectionrevision
| Controls persistence of user-driven changes in
| selected points from all traces.
| selections
| A tuple of
| :class:`plotly.graph_objects.layout.Selection`
| instances or dicts with compatible properties
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets
| the default property values to use for elements
| of layout.selections
| 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
| A tuple of
| :class:`plotly.graph_objects.layout.Shape`
| instances or dicts with compatible properties
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the
| default property values to use for elements of
| layout.shapes
| showlegend
| Determines whether or not a legend is drawn.
| Default is `true` if there is a trace to show
| and any of these: a) Two or more traces would
| by default be shown in the legend. b) One pie
| trace is shown in the legend. c) One trace is
| explicitly given with `showlegend: true`.
| sliders
| A tuple of
| :class:`plotly.graph_objects.layout.Slider`
| instances or dicts with compatible properties
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets
| the default property values to use for elements
| of layout.sliders
| smith
| :class:`plotly.graph_objects.layout.Smith`
| 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.
| sunburstcolorway
| Sets the default sunburst slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendsunburstcolors`.
| template
| Default attributes to be applied to the plot.
| This should be a dict with format: `{'layout':
| layoutTemplate, 'data': {trace_type:
| [traceTemplate, ...], ...}}` where
| `layoutTemplate` is a dict matching the
| structure of `figure.layout` and
| `traceTemplate` is a dict matching the
| structure of the trace with type `trace_type`
| (e.g. 'scatter'). Alternatively, this may be
| specified as an instance of
| plotly.graph_objs.layout.Template. Trace
| templates are applied cyclically to traces of
| each type. Container arrays (eg `annotations`)
| have special handling: An object ending in
| `defaults` (eg `annotationdefaults`) is applied
| to each array item. But if an item has a
| `templateitemname` key we look in the template
| array for an item with matching `name` and
| apply that instead. If no matching `name` is
| found we mark the item invisible. Any named
| template item not referenced is appended to the
| end of the array, so this can be used to add a
| watermark annotation or a logo image, for
| example. To omit one of these items on the
| plot, make an item with matching
| `templateitemname` and `visible: false`.
| ternary
| :class:`plotly.graph_objects.layout.Ternary`
| instance or dict with compatible properties
| title
| :class:`plotly.graph_objects.layout.Title`
| instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.title.font
| instead. Sets the title font. Note that the
| title's font used to be customized by the now
| deprecated `titlefont` attribute.
| transition
| Sets transition options used during
| Plotly.react updates.
| treemapcolorway
| Sets the default treemap slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendtreemapcolors`.
| uirevision
| Used to allow user interactions with the plot
| to persist after `Plotly.react` calls that are
| unaware of these interactions. If `uirevision`
| is omitted, or if it is given and it changed
| from the previous `Plotly.react` call, the
| exact new figure is used. If `uirevision` is
| truthy and did NOT change, any attribute that
| has been affected by user interactions and did
| not receive a different value in the new figure
| will keep the interaction value.
| `layout.uirevision` attribute serves as the
| default for `uirevision` attributes in various
| sub-containers. For finer control you can set
| these sub-attributes directly. For example, if
| your app separately controls the data on the x
| and y axes you might set
| `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y
| data is changed, you can update
| `yaxis.uirevision=*quantity*` and the y axis
| range will reset but the x axis range will
| retain any user-driven zoom.
| uniformtext
| :class:`plotly.graph_objects.layout.Uniformtext
| ` instance or dict with compatible properties
| updatemenus
| A tuple of
| :class:`plotly.graph_objects.layout.Updatemenu`
| instances or dicts with compatible properties
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults),
| sets the default property values to use for
| elements of layout.updatemenus
| violingap
| Sets the gap (in plot fraction) between violins
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| violingroupgap
| Sets the gap (in plot fraction) between violins
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| violinmode
| Determines how violins at the same location
| coordinate are displayed on the graph. If
| "group", the violins are plotted next to one
| another centered around the shared location. If
| "overlay", the violins are plotted over one
| another, you might need to set "opacity" to see
| them multiple violins. Has no effect on traces
| that have "width" set.
| waterfallgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| waterfallmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "group", the bars are plotted next to one
| another centered around the shared location.
| With "overlay", the bars are plotted over one
| another, you might need to reduce "opacity" to
| see multiple bars.
| width
| Sets the plot's width (in px).
| xaxis
| :class:`plotly.graph_objects.layout.XAxis`
| instance or dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.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
|
| skip_invalid: bool
| If True, invalid properties in the figure specification will be
| skipped silently. If False (default) invalid properties in the
| figure specification will result in a ValueError
|
| Raises
| ------
| ValueError
| if a property in the specification of data, layout, or frames
| is invalid AND skip_invalid is False
|
| add_annotation(self, arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new annotation to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Annotation or dict with compatible
| properties
| align
| Sets the horizontal alignment of the `text` within the
| box. Has an effect only if `text` spans two or more
| lines (i.e. `text` contains one or more <br> HTML tags)
| or if an explicit width is set to override the text
| width.
| arrowcolor
| Sets the color of the annotation arrow.
| arrowhead
| Sets the end annotation arrow head style.
| arrowside
| Sets the annotation arrow head position.
| arrowsize
| Sets the size of the end annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| arrowwidth
| Sets the width (in px) of annotation arrow line.
| ax
| Sets the x component of the arrow tail about the arrow
| head. If `axref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from right
| to left (left to right). If `axref` is not `pixel` and
| is exactly the same as `xref`, this is an absolute
| value on that axis, like `x`, specified in the same
| coordinates as `xref`.
| axref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a x axis id
| (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis. In order for absolute
| positioning of the arrow to work, "axref" must be
| exactly the same as "xref", otherwise "axref" will
| revert to "pixel" (explained next). For relative
| positioning, "axref" can be set to "pixel", in which
| case the "ax" value is specified in pixels relative to
| "x". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| ay
| Sets the y component of the arrow tail about the arrow
| head. If `ayref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from bottom
| to top (top to bottom). If `ayref` is not `pixel` and
| is exactly the same as `yref`, this is an absolute
| value on that axis, like `y`, specified in the same
| coordinates as `yref`.
| ayref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a y axis id
| (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis. In order for absolute
| positioning of the arrow to work, "ayref" must be
| exactly the same as "yref", otherwise "ayref" will
| revert to "pixel" (explained next). For relative
| positioning, "ayref" can be set to "pixel", in which
| case the "ay" value is specified in pixels relative to
| "y". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| bgcolor
| Sets the background color of the annotation.
| bordercolor
| Sets the color of the border enclosing the annotation
| `text`.
| borderpad
| Sets the padding (in px) between the `text` and the
| enclosing border.
| borderwidth
| Sets the width (in px) of the border enclosing the
| annotation `text`.
| captureevents
| Determines whether the annotation text box captures
| mouse move and click events, or allows those events to
| pass through to data points in the plot that may be
| behind the annotation. By default `captureevents` is
| False unless `hovertext` is provided. If you use the
| event `plotly_clickannotation` without `hovertext` you
| must explicitly enable `captureevents`.
| clicktoshow
| Makes this annotation respond to clicks on the plot. If
| you click a data point that exactly matches the `x` and
| `y` values of this annotation, and it is hidden
| (visible: false), it will appear. In "onoff" mode, you
| must click the same point again to make it disappear,
| so if you click multiple points, you can show multiple
| annotations. In "onout" mode, a click anywhere else in
| the plot (on another data point or not) will hide this
| annotation. If you need to show/hide this annotation in
| response to different `x` or `y` values, you can set
| `xclick` and/or `yclick`. This is useful for example to
| label the side of a bar. To label markers though,
| `standoff` is preferred over `xclick` and `yclick`.
| font
| Sets the annotation text font.
| height
| Sets an explicit height for the text box. null
| (default) lets the text set the box height. Taller text
| will be clipped.
| hoverlabel
| :class:`plotly.graph_objects.layout.annotation.Hoverlab
| el` instance or dict with compatible properties
| hovertext
| Sets text to appear when hovering over this annotation.
| If omitted or blank, no hover label will appear.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the annotation (text + arrow).
| showarrow
| Determines whether or not the annotation is drawn with
| an arrow. If True, `text` is placed near the arrow's
| tail. If False, `text` lines up with the `x` and `y`
| provided.
| standoff
| Sets a distance, in pixels, to move the end arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| startarrowhead
| Sets the start annotation arrow head style.
| startarrowsize
| Sets the size of the start annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| startstandoff
| Sets a distance, in pixels, to move the start arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| text
| Sets the text associated with this annotation. Plotly
| uses a subset of HTML tags to do things like newline
| (<br>), bold (<b></b>), italics (<i></i>), hyperlinks
| (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>
| <span> are also supported.
| textangle
| Sets the angle at which the `text` is drawn with
| respect to the horizontal.
| valign
| Sets the vertical alignment of the `text` within the
| box. Has an effect only if an explicit height is set to
| override the text height.
| visible
| Determines whether or not this annotation is visible.
| width
| Sets an explicit width for the text box. null (default)
| lets the text set the box width. Wider text will be
| clipped. There is no automatic wrapping; use <br> to
| start a new line.
| x
| Sets the annotation's x position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| xanchor
| Sets the text box's horizontal position anchor This
| anchor binds the `x` position to the "left", "center"
| or "right" of the annotation. For example, if `x` is
| set to 1, `xref` to "paper" and `xanchor` to "right"
| then the right-most portion of the annotation lines up
| with the right-most edge of the plotting area. If
| "auto", the anchor is equivalent to "center" for data-
| referenced annotations or if there is an arrow, whereas
| for paper-referenced with no arrow, the anchor picked
| corresponds to the closest side.
| xclick
| Toggle this annotation when clicking a data point whose
| `x` value is `xclick` rather than the annotation's `x`
| value.
| xref
| Sets the annotation's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xshift
| Shifts the position of the whole annotation and arrow
| to the right (positive) or left (negative) by this many
| pixels.
| y
| Sets the annotation's y position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| yanchor
| Sets the text box's vertical position anchor This
| anchor binds the `y` position to the "top", "middle" or
| "bottom" of the annotation. For example, if `y` is set
| to 1, `yref` to "paper" and `yanchor` to "top" then the
| top-most portion of the annotation lines up with the
| top-most edge of the plotting area. If "auto", the
| anchor is equivalent to "middle" for data-referenced
| annotations or if there is an arrow, whereas for paper-
| referenced with no arrow, the anchor picked corresponds
| to the closest side.
| yclick
| Toggle this annotation when clicking a data point whose
| `y` value is `yclick` rather than the annotation's `y`
| value.
| yref
| Sets the annotation's y coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| yshift
| Shifts the position of the whole annotation and arrow
| up (positive) or down (negative) by this many pixels.
| row
| Subplot row for annotation. If 'all', addresses all
| rows in the specified column(s).
| col
| Subplot column for annotation. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add annotation to secondary y-axis
| exclude_empty_subplots
| If True, annotation will not be added to subplots
| without traces.
|
| Returns
| -------
| Figure
|
| add_bar(self, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Bar trace
|
| The data visualized by the span of the bars is set in `y` if
| `orientation` is set to "v" (the default) and the labels are
| set in `x`. By setting `orientation` to "h", the roles are
| interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units). In "stack" or "relative" barmode, traces that
| set "base" will be excluded and drawn in "overlay" mode
| instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.bar.ErrorX` instance or
| dict with compatible properties
| error_y
| :class:`plotly.graph_objects.bar.ErrorY` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.bar.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`. Anything contained in
| tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.bar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.bar.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.bar.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.bar.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.bar.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_barpolar(self, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Barpolar trace
|
| The data visualized by the radial span of the bars is set in
| `r`
|
| Parameters
| ----------
| base
| Sets where the bar base is drawn (in radial axis
| units). In "stack" barmode, traces that set "base" will
| be excluded and drawn in "overlay" mode instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.barpolar.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.barpolar.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.barpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.barpolar.Stream` instance
| or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.barpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar angular width (in "thetaunit" units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_box(self, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Box trace
|
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2, i.e. the median) is marked by a line
| inside the box. The fences grow outward from the boxes' edges,
| by default they span +/- 1.5 times the interquartile range
| (IQR: Q3-Q1), The sample mean and standard deviation as well as
| notches and the sample, outlier and suspected outliers points
| can be optionally added to the box plot. The values and
| positions corresponding to each boxes can be input using two
| signatures. The first signature expects users to supply the
| sample values in the `y` data array for vertical boxes (`x` for
| horizontal boxes). By supplying an `x` (`y`) array, one box per
| distinct `x` (`y`) value is drawn If no `x` (`y`) list is
| provided, a single box is drawn. In this case, the box is
| positioned with the trace `name` or with `x0` (`y0`) if
| provided. The second signature expects users to supply the
| boxes corresponding Q1, median and Q3 statistics in the `q1`,
| `median` and `q3` data arrays respectively. Other box features
| relying on statistics namely `lowerfence`, `upperfence`,
| `notchspan` can be set directly by the users. To have plotly
| compute them or to show sample points besides the boxes, users
| can set the `y` data array for vertical boxes (`x` for
| horizontal boxes) to a 2D array with the outer length
| corresponding to the number of boxes in the traces and the
| inner length corresponding the sample size.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| boxmean
| If True, the mean of the box(es)' underlying
| distribution is drawn as a dashed line inside the
| box(es). If "sd" the standard deviation is also drawn.
| Defaults to True when `mean` is set. Defaults to "sd"
| when `sd` is set Otherwise defaults to False.
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the box(es) are shown with no sample
| points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set. Defaults to "all" under the q1/median/q3
| signature. Otherwise defaults to "outliers".
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step for multi-box traces set
| using q1/median/q3.
| dy
| Sets the y coordinate step for multi-box traces set
| using q1/median/q3.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.box.Hoverlabel` instance
| or dict with compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the box(es).
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.box.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.box.Line` instance or dict
| with compatible properties
| lowerfence
| Sets the lower fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `lowerfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the lower as the last sample
| point below 1.5 times the IQR.
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
| marker
| :class:`plotly.graph_objects.box.Marker` instance or
| dict with compatible properties
| mean
| Sets the mean values. There should be as many items as
| the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `mean` is not
| provided but a sample (in `y` or `x`) is set, we
| compute the mean for each box using the sample values.
| meansrc
| Sets the source reference on Chart Studio Cloud for
| `mean`.
| median
| Sets the median values. There should be as many items
| as the number of boxes desired.
| mediansrc
| Sets the source reference on Chart Studio Cloud for
| `median`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For box traces, the name will
| also be used for the position coordinate, if `x` and
| `x0` (`y` and `y0` if horizontal) are missing and the
| position axis is categorical
| notched
| Determines whether or not notches are drawn. Notches
| displays a confidence interval around the median. We
| compute the confidence interval as median +/- 1.57 *
| IQR / sqrt(N), where IQR is the interquartile range and
| N is the sample size. If two boxes' notches do not
| overlap there is 95% confidence their medians differ.
| See https://sites.google.com/site/davidsstatistics/home
| /notched-box-plots for more info. Defaults to False
| unless `notchwidth` or `notchspan` is set.
| notchspan
| Sets the notch span from the boxes' `median` values.
| There should be as many items as the number of boxes
| desired. This attribute has effect only under the
| q1/median/q3 signature. If `notchspan` is not provided
| but a sample (in `y` or `x`) is set, we compute it as
| 1.57 * IQR / sqrt(N), where N is the sample size.
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
| notchwidth
| Sets the width of the notches relative to the box'
| width. For example, with 0, the notches are as wide as
| the box(es).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the box(es). If 0, the sample points are places over
| the center of the box(es). Positive (negative) values
| correspond to positions to the right (left) for
| vertical boxes and above (below) for horizontal boxes
| q1
| Sets the Quartile 1 values. There should be as many
| items as the number of boxes desired.
| q1src
| Sets the source reference on Chart Studio Cloud for
| `q1`.
| q3
| Sets the Quartile 3 values. There should be as many
| items as the number of boxes desired.
| q3src
| Sets the source reference on Chart Studio Cloud for
| `q3`.
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| sd
| Sets the standard deviation values. There should be as
| many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3
| signature. If `sd` is not provided but a sample (in `y`
| or `x`) is set, we compute the standard deviation for
| each box using the sample values.
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to
| be drawn across any stddev range For example 1-stddev,
| 3-stddev, 5-stddev
| sdsrc
| Sets the source reference on Chart Studio Cloud for
| `sd`.
| selected
| :class:`plotly.graph_objects.box.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showwhiskers
| Determines whether or not whiskers are visible.
| Defaults to true for `sizemode` "quartiles", false for
| "sd".
| sizemode
| Sets the upper and lower bound for the boxes quartiles
| means box is drawn between Q1 and Q3 SD means the box
| is drawn between Mean +- Standard Deviation Argument
| sdmultiple (default 1) to scale the box size So it
| could be drawn 1-stddev, 3-stddev etc
| stream
| :class:`plotly.graph_objects.box.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.box.Unselected` instance
| or dict with compatible properties
| upperfence
| Sets the upper fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `upperfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the upper as the last sample
| point above 1.5 times the IQR.
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| width
| Sets the width of the box in data coordinate If 0
| (default value) the width is automatically selected
| based on the positions of other box traces in the same
| subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_candlestick(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Candlestick trace
|
| The candlestick is a style of financial chart describing open,
| high, low and close for a given `x` coordinate (most likely
| time). The boxes represent the spread between the `open` and
| `close` values and the lines represent the spread between the
| `low` and `high` values Sample points where the close value is
| higher (lower) then the open value are called increasing
| (decreasing). By default, increasing candles are drawn in green
| whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.candlestick.Decreasing`
| instance or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.candlestick.Hoverlabel`
| instance or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.candlestick.Increasing`
| instance or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.candlestick.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.candlestick.Line` instance
| or dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.candlestick.Stream`
| instance or dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| 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, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Carpet trace
|
| The data describing carpet axis layout is set in `y` and
| (optionally) also `x`. If only `y` is present, `x` the plot is
| interpreted as a cheater plot and is filled in using the `y`
| values. `x` and `y` may either be 2D arrays matching with each
| dimension matching that of `a` and `b`, or they may be 1D
| arrays with total length equal to that of `a` and `b`.
|
| Parameters
| ----------
| a
| An array containing values of the first parameter value
| a0
| Alternate to `a`. Builds a linear space of a
| coordinates. Use with `da` where `a0` is the starting
| coordinate and `da` the step.
| aaxis
| :class:`plotly.graph_objects.carpet.Aaxis` instance or
| dict with compatible properties
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| A two dimensional array of y coordinates at each carpet
| point.
| b0
| Alternate to `b`. Builds a linear space of a
| coordinates. Use with `db` where `b0` is the starting
| coordinate and `db` the step.
| baxis
| :class:`plotly.graph_objects.carpet.Baxis` instance or
| dict with compatible properties
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| cheaterslope
| The shift applied to each successive row of data in
| creating a cheater plot. Only used if `x` is been
| omitted.
| color
| Sets default for all colors associated with this axis
| all at once: line, font, tick, and grid colors. Grid
| color is lightened by blending this with the plot
| background Individual pieces can override this.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the a coordinate step. See `a0` for more info.
| db
| Sets the b coordinate step. See `b0` for more info.
| font
| The default font used for axis & tick labels on this
| carpet
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.carpet.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| stream
| :class:`plotly.graph_objects.carpet.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| A two dimensional array of x coordinates at each carpet
| point. If omitted, the plot is a cheater plot and the
| xaxis is hidden by default.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| A two dimensional array of y coordinates at each carpet
| point.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_choropleth(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Choropleth trace
|
| The data that describes the choropleth value-to-color mapping
| is set in `z`. The geographic locations corresponding to each
| value in `z` are set in `locations`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choropleth.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choropleth.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choropleth.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choropleth.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choropleth.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choropleth.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choropleth.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_choroplethmap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Choroplethmap trace
|
| GeoJSON features to be filled are set in `geojson` The data
| that describes the choropleth value-to-color mapping is set in
| `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmap traces are placed above the water layers.
| If set to '', the layer will be inserted above every
| existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmap.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_choroplethmapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Choroplethmapbox trace
|
| "choroplethmapbox" trace is deprecated! Please consider
| switching to the "choroplethmap" trace type and `map` subplots.
| Learn more at: https://plotly.com/javascript/maplibre-
| migration/ GeoJSON features to be filled are set in `geojson`
| The data that describes the choropleth value-to-color mapping
| is set in `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmapbox traces are placed above the water
| layers. If set to '', the layer will be inserted above
| every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
| l` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmapbox.Legendgro
| uptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmapbox.Unselecte
| d` instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_cone(self, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Cone trace
|
| Use cone traces to visualize vector fields. Specify a vector
| field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and
| 3 vector component arrays `u`, `v`, `w`. The cones are drawn
| exactly at the positions given by `x`, `y` and `z`.
|
| Parameters
| ----------
| anchor
| Sets the cones' anchor with respect to their x/y/z
| positions. Note that "cm" denote the cone's center of
| mass which corresponds to 1/4 from the tail to tip.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.cone.ColorBar` instance or
| dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.cone.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `norm` Anything contained in tag `<extra>`
| is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.cone.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.cone.Lighting` instance or
| dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.cone.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in
| the vector field) or as "absolute" value (in the same
| units as the vector field). To display sizes in actual
| vector length use "raw".
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally)
| corresponds to the minimum "time" to travel across two
| successive x/y/z positions at the average velocity of
| those two successive positions. All cones in a given
| trace use the same factor. With `sizemode` set to
| "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is
| 0.5. With `sizemode` set to "absolute", `sizeref` has
| the same units as the u/v/w vector field, its the
| default value is half the sample's maximum vector norm.
| stream
| :class:`plotly.graph_objects.cone.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the cones. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_contour(self, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Contour trace
|
| The data from which contour lines are computed is set in `z`.
| Data in `z` must be a 2D list of numbers. Say that `z` has N
| rows and M columns, then by default, these N rows correspond to
| N y coordinates (set in `y` or auto-generated) and the M
| columns correspond to M x coordinates (set in `x` or auto-
| generated). By setting `transpose` to True, the above behavior
| is flipped.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contour.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array otherwise it
| is defaulted to false.
| contours
| :class:`plotly.graph_objects.contour.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.contour.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contour.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contour.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contour.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| 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, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Contourcarpet trace
|
| Plots contours on either the first carpet axis or the carpet
| axis with a matching `carpet` attribute. Data `z` is
| interpreted as matching that of the corresponding carpet axis.
|
| Parameters
| ----------
| a
| Sets the x coordinates.
| a0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| atype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| b
| Sets the y coordinates.
| b0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| btype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| carpet
| The `carpet` of the carpet axes on which this contour
| trace lies
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contourcarpet.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.contourcarpet.Contours`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the x coordinate step. See `x0` for more info.
| db
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contourcarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contourcarpet.Line`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contourcarpet.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_densitymap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Densitymap trace
|
| Draws a bivariate kernel density estimation with a Gaussian
| kernel from `lon` and `lat` coordinates and optional `z` values
| using a colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymap trace will be inserted
| before the layer with the specified ID. By default,
| densitymap traces are placed below the first layer of
| type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymap
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_densitymapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Densitymapbox trace
|
| "densitymapbox" trace is deprecated! Please consider switching
| to the "densitymap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ Draws a
| bivariate kernel density estimation with a Gaussian kernel from
| `lon` and `lat` coordinates and optional `z` values using a
| colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymapbox trace will be inserted
| before the layer with the specified ID. By default,
| densitymapbox traces are placed below the first layer
| of type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymapbox
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_funnel(self, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Funnel trace
|
| Visualize stages in a process using length-encoded bars. This
| trace can be used to show data in either a part-to-whole
| representation wherein each item appears in a single stage, or
| in a "drop-off" representation wherein each item appears in
| each stage it traversed. See also the "funnelarea" trace type
| for a different approach to visualizing funnel data.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.funnel.Connector` instance
| or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnel.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious` and
| `percentTotal`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnel.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnel.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the funnels. With "v" ("h"),
| the value of the each bar spans along the vertical
| (horizontal). By default funnels are tend to be
| oriented horizontally; unless only "y" array is
| presented or orientation is set to "v". Also regarding
| graphs including only 'horizontal' funnels, "autorange"
| on the "y-axis" are set to "reversed".
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnel.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple funnels, percentages &
| totals are computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious`,
| `percentTotal`, `label` and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_funnelarea(self, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Funnelarea trace
|
| Visualize stages in a process using area-encoded trapezoids.
| This trace can be used to show data in a part-to-whole
| representation similar to a "pie" trace, wherein each item
| appears in a single stage. See also the "funnel" trace type for
| a different approach to visualizing funnel data.
|
| Parameters
| ----------
| aspectratio
| Sets the ratio between height and width
| baseratio
| Sets the ratio between bottom length and maximum top
| length.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.funnelarea.Domain`
| instance or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnelarea.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnelarea.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnelarea.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnelarea.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.funnelarea.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_heatmap(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Heatmap trace
|
| The data that describes the heatmap value-to-color mapping is
| set in `z`. Data in `z` can either be a 2D list of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a 2D list, say that `z` has N rows and M columns. Then, by
| default, the resulting heatmap will have N partitions along the
| y axis and M partitions along the x axis. In other words, the
| i-th row/ j-th column cell in `z` is mapped to the i-th
| partition of the y axis (starting from the bottom of the plot)
| and the j-th partition of the x-axis (starting from the left of
| the plot). This behavior can be flipped by using `transpose`.
| Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1)
| elements. If M (N), then the coordinates correspond to the
| center of the heatmap cells and the cells have equal width. If
| M+1 (N+1), then the coordinates correspond to the edges of the
| heatmap cells. In the case where `z` is a 1D list, the x and y
| coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmap.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array and `zsmooth`
| is not false; otherwise it is defaulted to false.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmap.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmap.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_heatmapgl(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Heatmapgl trace
|
| "heatmapgl" trace is deprecated! Please consider switching to
| the "heatmap" or "image" trace types. Alternatively you could
| contribute/sponsor rewriting this trace type based on cartesian
| features and using regl framework. WebGL version of the heatmap
| trace type.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmapgl.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmapgl.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmapgl.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_histogram(self, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Histogram trace
|
| The sample data from which statistics are computed is set in
| `x` for vertically spanning histograms and in `y` for
| horizontally spanning histograms. Binning options are set
| `xbins` and `ybins` respectively if no aggregation data is
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| bingroup
| Set a group of histogram traces which will have
| compatible bin settings. Note that traces on the same
| subplot and with the same "orientation" under `barmode`
| "stack", "relative" and "group" are forced into the
| same bingroup, Using `bingroup`, traces under `barmode`
| "overlay" and on different axes (of the same axis type)
| can have compatible bin settings. Note that histogram
| and histogram2d* trace can share the same `bingroup`
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| cumulative
| :class:`plotly.graph_objects.histogram.Cumulative`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.histogram.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.histogram.ErrorY` instance
| or dict with compatible properties
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `binNumber` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.histogram.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.histogram.Stream` instance
| or dict with compatible properties
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the text font.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label` and `value`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.histogram.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbins
| :class:`plotly.graph_objects.histogram.XBins` instance
| or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybins
| :class:`plotly.graph_objects.histogram.YBins` instance
| or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_histogram2d(self, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Histogram2d trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a heatmap.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2d.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2d.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram2d.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2d.Stream`
| instance or dict with compatible properties
| textfont
| Sets the text font.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z`
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2d.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2d.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_histogram2dcontour(self, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Histogram2dContour trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a contour plot.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2dcontour.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.histogram2dcontour.Contour
| s` instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2dcontour.Hoverla
| bel` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2dcontour.Legendg
| rouptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.histogram2dcontour.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.histogram2dcontour.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2dcontour.Stream`
| instance or dict with compatible properties
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2dcontour.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2dcontour.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_hline(self, y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a horizontal line to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y: float or int
| A number representing the y coordinate of the horizontal line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_hrect(self, y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a rectangle to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y0: float or int
| A number representing the y coordinate of one side of the rectangle.
| y1: float or int
| A number representing the y coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_icicle(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Icicle trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The icicle sectors are determined
| by the entries in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.icicle.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.icicle.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.icicle.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.icicle.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.icicle.Marker` instance or
| dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.icicle.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.icicle.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.icicle.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.icicle.Tiling` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_image(self, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Image trace
|
| Display an image, i.e. data on a 2D regular raster. By default,
| when an image is displayed in a subplot, its y axis will be
| reversed (ie. `autorange: 'reversed'`), constrained to the
| domain (ie. `constrain: 'domain'`) and it will have the same
| scale as its x axis (ie. `scaleanchor: 'x,`) in order for
| pixels to be rendered as squares.
|
| Parameters
| ----------
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified,
| this attribute will be set to `rgba256` otherwise it
| defaults to `rgb`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Set the pixel's horizontal size.
| dy
| Set the pixel's vertical size
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.image.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `z`, `color` and `colormodel`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.image.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| source
| Specifies the data URI of the image to be visualized.
| The URI consists of "data:image/[<media
| subtype>][;base64],<data>"
| stream
| :class:`plotly.graph_objects.image.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Set the image's x position. The left edge of the image
| (or the right edge if the x axis is reversed or dx is
| negative) will be found at xmin=x0-dx/2
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| y0
| Set the image's y position. The top edge of the image
| (or the bottom edge if the y axis is NOT reversed or if
| dy is negative) will be found at ymin=y0-dy/2. By
| default when an image trace is included, the y axis
| will be reversed so that the image is right-side-up,
| but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis
| range.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| A 2-dimensional array in which each element is an array
| of 3 or 4 numbers representing a color.
| zmax
| Array defining the higher bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [255,
| 255, 255]. For the `rgba` colormodel, it is [255, 255,
| 255, 1]. For the `rgba256` colormodel, it is [255, 255,
| 255, 255]. For the `hsl` colormodel, it is [360, 100,
| 100]. For the `hsla` colormodel, it is [360, 100, 100,
| 1].
| zmin
| Array defining the lower bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [0, 0,
| 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For
| the `rgba256` colormodel, it is [0, 0, 0, 0]. For the
| `hsl` colormodel, it is [0, 0, 0]. For the `hsla`
| colormodel, it is [0, 0, 0, 0].
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data.
| This only applies for image traces that use the
| `source` attribute.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_indicator(self, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Indicator trace
|
| An indicator is used to visualize a single `value` along with
| some contextual information such as `steps` or a `threshold`,
| using a combination of three visual elements: a number, a
| delta, and/or a gauge. Deltas are taken with respect to a
| `reference`. Gauges can be either angular or bullet (aka
| linear) gauges.
|
| Parameters
| ----------
| align
| Sets the horizontal alignment of the `text` within the
| box. Note that this attribute has no effect if an
| angular gauge is displayed: in this case, it is always
| centered
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delta
| :class:`plotly.graph_objects.indicator.Delta` instance
| or dict with compatible properties
| domain
| :class:`plotly.graph_objects.indicator.Domain` instance
| or dict with compatible properties
| gauge
| The gauge of the Indicator plot.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.indicator.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines how the value is displayed on the graph.
| `number` displays the value numerically in text.
| `delta` displays the difference to a reference value in
| text. Finally, `gauge` displays the value graphically
| on an axis.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| number
| :class:`plotly.graph_objects.indicator.Number` instance
| or dict with compatible properties
| stream
| :class:`plotly.graph_objects.indicator.Stream` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.indicator.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the number to be displayed.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_isosurface(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Isosurface trace
|
| Draws isosurfaces between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.isosurface.Caps` instance
| or dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.isosurface.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.isosurface.Contour`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.isosurface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.isosurface.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.isosurface.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.isosurface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.isosurface.Slices`
| instance or dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.isosurface.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.isosurface.Stream`
| instance or dict with compatible properties
| surface
| :class:`plotly.graph_objects.isosurface.Surface`
| instance or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_layout_image(self, arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new image to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Image or dict with compatible properties
| layer
| Specifies whether images are drawn below or above
| traces. When `xref` and `yref` are both set to `paper`,
| image is drawn below the entire plot area.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the image.
| sizex
| Sets the image container size horizontally. The image
| will be sized based on the `position` value. When
| `xref` is set to `paper`, units are sized relative to
| the plot width. When `xref` ends with ` domain`, units
| are sized relative to the axis width.
| sizey
| Sets the image container size vertically. The image
| will be sized based on the `position` value. When
| `yref` is set to `paper`, units are sized relative to
| the plot height. When `yref` ends with ` domain`, units
| are sized relative to the axis height.
| sizing
| Specifies which dimension of the image to constrain.
| source
| Specifies the URL of the image to be used. The URL must
| be accessible from the domain where the plot code is
| run, and can be either relative or absolute.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| visible
| Determines whether or not this image is visible.
| x
| Sets the image's x position. When `xref` is set to
| `paper`, units are sized relative to the plot height.
| See `xref` for more info
| xanchor
| Sets the anchor for the x position
| xref
| Sets the images's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y
| Sets the image's y position. When `yref` is set to
| `paper`, units are sized relative to the plot height.
| See `yref` for more info
| yanchor
| Sets the anchor for the y position.
| yref
| Sets the images's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for image. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for image. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add image to secondary y-axis
| exclude_empty_subplots
| If True, image will not be added to subplots without
| traces.
|
| Returns
| -------
| Figure
|
| add_mesh3d(self, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Mesh3d trace
|
| Draws sets of triangles with coordinates given by three
| 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`,
| `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-
| shape algorithm or (4) the Convex-hull algorithm
|
| Parameters
| ----------
| alphahull
| Determines how the mesh surface triangles are derived
| from the set of vertices (points) represented by the
| `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays
| are not supplied. For general use of `mesh3d` it is
| preferred that `i`, `j`, `k` are supplied. If "-1",
| Delaunay triangulation is used, which is mainly
| suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In
| case the `delaunayaxis` intersects the mesh surface at
| more than one point it will result triangles that are
| very long in the dimension of `delaunayaxis`. If ">0",
| the alpha-shape algorithm is used. In this case, the
| positive `alphahull` value signals the use of the
| alpha-shape algorithm, _and_ its value acts as the
| parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or
| if the intention is to enclose the `x`, `y` and `z`
| point set into a convex hull.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `intensity`) or
| the bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `intensity`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmax`
| must be set as well.
| color
| Sets the color of the whole mesh
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.mesh3d.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.mesh3d.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is
| perpendicular to the surface of the Delaunay
| triangulation. It has an effect if `i`, `j`, `k` are
| not provided and `alphahull` is set to indicate
| Delaunay triangulation.
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.mesh3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| i
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "first" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `i[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `i` represents a point in space, which
| is the first vertex of a triangle.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| intensity
| Sets the intensity values for vertices or cells as
| defined by `intensitymode`. It can be used for plotting
| fields on meshes.
| intensitymode
| Determines the source of `intensity` values.
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
| isrc
| Sets the source reference on Chart Studio Cloud for
| `i`.
| j
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "second" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `j[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `j` represents a point in space, which
| is the second vertex of a triangle.
| jsrc
| Sets the source reference on Chart Studio Cloud for
| `j`.
| k
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "third" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `k[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `k` represents a point in space, which
| is the third vertex of a triangle.
| ksrc
| Sets the source reference on Chart Studio Cloud for
| `k`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.mesh3d.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.mesh3d.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.mesh3d.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.mesh3d.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| vertexcolor
| Sets the color of each vertex Overrides "color". While
| Red, green and blue colors are in the range of 0 and
| 255; in the case of having vertex color data in RGBA
| format, the alpha color should be normalized to be
| between 0 and 1.
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_ohlc(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Ohlc trace
|
| The ohlc (short for Open-High-Low-Close) is a style of
| financial chart describing open, high, low and close for a
| given `x` coordinate (most likely time). The tip of the lines
| represent the `low` and `high` values and the horizontal
| segments represent the `open` and `close` values. Sample points
| where the close value is higher (lower) then the open value are
| called increasing (decreasing). By default, increasing items
| are drawn in green whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.ohlc.Decreasing` instance
| or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.ohlc.Hoverlabel` instance
| or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.ohlc.Increasing` instance
| or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.ohlc.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.ohlc.Line` instance or
| dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.ohlc.Stream` instance or
| dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| tickwidth
| Sets the width of the open/close tick marks relative to
| the "x" minimal interval.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_parcats(self, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Parcats trace
|
| Parallel categories diagram for multidimensional categorical
| data.
|
| Parameters
| ----------
| arrangement
| Sets the drag interaction mode for categories and
| dimensions. If `perpendicular`, the categories can only
| move along a line perpendicular to the paths. If
| `freeform`, the categories can freely move on the
| plane. If `fixed`, the categories and dimensions are
| stationary.
| bundlecolors
| Sort paths so that like colors are bundled together
| within each category.
| counts
| The number of observations represented by each state.
| Defaults to 1 so that each state represents one
| observation
| countssrc
| Sets the source reference on Chart Studio Cloud for
| `counts`.
| dimensions
| The dimensions (variables) of the parallel categories
| diagram.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets
| the default property values to use for elements of
| parcats.dimensions
| domain
| :class:`plotly.graph_objects.parcats.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoveron
| Sets the hover interaction mode for the parcats
| diagram. If `category`, hover interaction take place
| per category. If `color`, hover interactions take place
| per color per category. If `dimension`, hover
| interactions take place across all categories per
| dimension.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. This value here applies when hovering
| over dimensions. Note that `*categorycount`,
| "colorcount" and "bandcolorcount" are only available
| when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`,
| `probability`, `category`, `categorycount`,
| `colorcount` and `bandcolorcount`. Anything contained
| in tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| labelfont
| Sets the font for the `dimension` labels.
| legendgrouptitle
| :class:`plotly.graph_objects.parcats.Legendgrouptitle`
| instance or dict with compatible properties
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcats.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort
| paths based on dimension categories from left to right.
| If `backward`, sort paths based on dimensions
| categories from right to left.
| stream
| :class:`plotly.graph_objects.parcats.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `category` labels.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_parcoords(self, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Parcoords trace
|
| Parallel coordinates for multidimensional exploratory data
| analysis. The samples are specified in `dimensions`. The colors
| are set in `line.color`.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets
| the default property values to use for elements of
| parcoords.dimensions
| domain
| :class:`plotly.graph_objects.parcoords.Domain` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| labelangle
| Sets the angle of the labels with respect to the
| horizontal. For example, a `tickangle` of -90 draws the
| labels vertically. Tilted labels with "labelangle" may
| be positioned better inside margins when
| `labelposition` is set to "bottom".
| labelfont
| Sets the font for the `dimension` labels.
| labelside
| Specifies the location of the `label`. "top" positions
| labels above, next to the title "bottom" positions
| labels below the graph Tilted labels with "labelangle"
| may be positioned better inside margins when
| `labelposition` is set to "bottom".
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.parcoords.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcoords.Line` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| rangefont
| Sets the font for the `dimension` range values.
| stream
| :class:`plotly.graph_objects.parcoords.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.parcoords.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_pie(self, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Pie trace
|
| A data visualized by the sectors of the pie is set in `values`.
| The sector labels are set in `labels`. The sector colors are
| set in `marker.colors`
|
| Parameters
| ----------
| automargin
| Determines whether outside text labels can push the
| margins.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| direction
| Specifies the direction at which succeeding sectors
| follow one another.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.pie.Domain` instance or
| dict with compatible properties
| hole
| Sets the fraction of the radius to cut out of the pie.
| Use this to make a donut chart.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pie.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pie.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pie.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector.
| pull
| Sets the fraction of larger radius to pull the sectors
| out from the center. This can be a constant to pull all
| slices apart from each other equally or an array to
| highlight one or more slices.
| pullsrc
| Sets the source reference on Chart Studio Cloud for
| `pull`.
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pie charts that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.pie.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.pie.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the
| font used for `title`. Note that the title's font used
| to be set by the now deprecated `titlefont` attribute.
| titleposition
| Deprecated: Please use pie.title.position instead.
| Specifies the location of the `title`. Note that the
| title's position used to be set by the now deprecated
| `titleposition` attribute.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_pointcloud(self, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Pointcloud trace
|
| "pointcloud" trace is deprecated! Please consider switching to
| the "scattergl" trace type. The data visualized as a point
| cloud set in `x` and `y` using the WebGl plotting engine.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pointcloud.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| indices
| A sequential value, 0..n, supply it to avoid creating
| this array inside plotting. If specified, it must be a
| typed `Int32Array` array. Its length must be equal to
| or greater than the number of points. For the best
| performance and memory use, create one large `indices`
| typed array that is guaranteed to be at least as long
| as the largest number of points during use, and reuse
| it on each `Plotly.restyle()` call.
| indicessrc
| Sets the source reference on Chart Studio Cloud for
| `indices`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pointcloud.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pointcloud.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.pointcloud.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `ybounds` for the performance
| benefits.
| xboundssrc
| Sets the source reference on Chart Studio Cloud for
| `xbounds`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xy
| Faster alternative to specifying `x` and `y`
| separately. If supplied, it must be a typed
| `Float32Array` array that represents points such that
| `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`
| xysrc
| Sets the source reference on Chart Studio Cloud for
| `xy`.
| y
| Sets the y coordinates.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `xbounds` for the performance
| benefits.
| yboundssrc
| Sets the source reference on Chart Studio Cloud for
| `ybounds`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_sankey(self, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Sankey trace
|
| Sankey plots for network flow data analysis. The nodes are
| specified in `nodes` and the links between sources and targets
| in `links`. The colors are set in `nodes[i].color` and
| `links[i].color`, otherwise defaults are used.
|
| Parameters
| ----------
| arrangement
| If value is `snap` (the default), the node arrangement
| is assisted by automatic snapping of elements to
| preserve space between nodes specified via `nodepad`.
| If value is `perpendicular`, the nodes can only move
| along a line perpendicular to the flow. If value is
| `freeform`, the nodes can freely move on the plane. If
| value is `fixed`, the nodes are stationary.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sankey.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired. Note that this attribute is
| superseded by `node.hoverinfo` and `node.hoverinfo` for
| nodes and links respectively.
| hoverlabel
| :class:`plotly.graph_objects.sankey.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sankey.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| link
| The links of the Sankey plot.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| orientation
| Sets the orientation of the Sankey diagram.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| stream
| :class:`plotly.graph_objects.sankey.Stream` instance or
| dict with compatible properties
| textfont
| Sets the font for node labels
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| valuesuffix
| Adds a unit to follow the value in the hover tooltip.
| Add a space if a separation is necessary from the
| value.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scatter(self, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Scatter trace
|
| The scatter trace type encompasses line charts, scatter charts,
| text charts, and bubble charts. The data visualized as scatter
| point or lines is set in `x` and `y`. Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scatter.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available. If fillgradient is
| specified, fillcolor is ignored except for setting the
| background color of the hover label, if any.
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor
| is used instead.
| fillpattern
| Sets the pattern within the marker.
| groupnorm
| Only relevant when `stackgroup` is used, and only the
| first `groupnorm` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Sets the normalization for the sum of
| this `stackgroup`. With "fraction", the value of each
| trace at each location is divided by the sum of all
| trace values at that location. "percent" is the same
| but multiplied by 100 to show percentages. If there are
| multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Only relevant in the following cases: 1. when
| `scattermode` is set to "group". 2. when `stackgroup`
| is used, and only the first `orientation` found in the
| `stackgroup` will be used - including if `visible` is
| "legendonly" but not if it is `false`. Sets the
| stacking direction. With "v" ("h"), the y (x) values of
| subsequent traces are added. Also affects the default
| value of `fill`.
| selected
| :class:`plotly.graph_objects.scatter.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stackgaps
| Only relevant when `stackgroup` is used, and only the
| first `stackgaps` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Determines how we handle locations at
| which other traces in this group have data but this one
| does not. With *infer zero* we insert a zero at these
| locations. With "interpolate" we linearly interpolate
| between existing values, and extrapolate a constant
| beyond the existing values.
| stackgroup
| Set several scatter traces (on the same subplot) to the
| same stackgroup in order to add their y values (or
| their x values if `orientation` is "h"). If blank or
| omitted this trace will not be stacked. Stacking also
| turns `fill` on by default, using "tonexty" ("tonextx")
| if `orientation` is "h" ("v") and sets the default
| `mode` to "lines" irrespective of point count. You can
| only stack on a numeric (linear or log) axis. Traces in
| a `stackgroup` will only fill to (or be filled to)
| other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if
| fill-linked traces are not already consecutive, the
| later ones will be pushed down in the drawing order.
| stream
| :class:`plotly.graph_objects.scatter.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatter.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_scatter3d(self, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatter3d trace
|
| The data visualized as scatter point or lines in 3D dimension
| is set in `x`, `y`, `z`. Text (appearing either on the chart or
| on hover only) is via `text`. Bubble charts are achieved by
| setting `marker.size` and/or `marker.color` Projections are
| achieved via `projection`. Surface fills are achieved via
| `surfaceaxis`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.scatter3d.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter3d.ErrorY` instance
| or dict with compatible properties
| error_z
| :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter3d.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter3d.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| projection
| :class:`plotly.graph_objects.scatter3d.Projection`
| instance or dict with compatible properties
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatter3d.Stream` instance
| or dict with compatible properties
| surfaceaxis
| If "-1", the scatter points are not fill with a surface
| If 0, 1, 2, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Scattercarpet trace
|
| Plots a scatter trace on either the first carpet axis or the
| carpet axis with a matching `carpet` attribute.
|
| Parameters
| ----------
| a
| Sets the a-axis coordinates.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the b-axis coordinates.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattercarpet.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b). To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattercarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattercarpet.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattercarpet.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattercarpet.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattercarpet.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (a,b) point. If
| a single string, the same string appears over all the
| data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattercarpet.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_scattergeo(self, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattergeo trace
|
| The data visualized as scatter point or lines on a geographic
| map is provided either by longitude/latitude pairs in `lon` and
| `lat` respectively or by geographic location IDs or names in
| `locations`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used
| when `locations` is set. It can be set as a valid
| GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or
| "Feature" with geometries of type "Polygon" or
| "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergeo.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair or item in `locations`. If a single string, the
| same string appears over all the data points. If an
| array of string, the items are mapped in order to the
| this trace's (lon,lat) or `locations` coordinates. To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergeo.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergeo.Line` instance
| or dict with compatible properties
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names.
| Coordinates correspond to the centroid of each location
| given. See `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattergeo.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergeo.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergeo.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (lon,lat) pair
| or item in `locations`. If a single string, the same
| string appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (lon,lat) or `locations` coordinates. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is
| not set, these elements will be seen in the hover
| labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon`, `location` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergeo.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Scattergl trace
|
| The data visualized as scatter point or lines is set in `x` and
| `y` using the WebGL plotting engine. Bubble charts are achieved
| by setting `marker.size` and/or `marker.color` to a numerical
| arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scattergl.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scattergl.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergl.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattergl.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergl.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_scattermap(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattermap trace
|
| The data visualized as scatter point, lines or marker symbols
| on a MapLibre GL geographic map is provided by
| longitude/latitude pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermap trace's layers are to be
| inserted before the layer with the specified ID. By
| default, scattermap layers are inserted above all the
| base layers. To place the scattermap layers above every
| other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermap.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermap.Line` instance
| or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=map.layer.paint.text-
| color, size=map.layer.layout.text-size). Has an effect
| only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scattermapbox(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattermapbox trace
|
| "scattermapbox" trace is deprecated! Please consider switching
| to the "scattermap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ The data
| visualized as scatter point, lines or marker symbols on a
| Mapbox GL geographic map is provided by longitude/latitude
| pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermapbox trace's layers are to
| be inserted before the layer with the specified ID. By
| default, scattermapbox layers are inserted above all
| the base layers. To place the scattermapbox layers
| above every other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermapbox.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermapbox.Line`
| instance or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-
| color, size=mapbox.layer.layout.text-size). Has an
| effect only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermapbox.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scatterpolar(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatterpolar trace
|
| The scatterpolar trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in polar coordinates.
| The data visualized as scatter point or lines is set in `r`
| (radial) and `theta` (angular) coordinates Text (appearing
| either on the chart or on hover only) is via `text`. Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterpolar has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolar.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolar.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolar.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolar.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolar.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scatterpolargl(self, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatterpolargl trace
|
| The scatterpolargl trace type encompasses line charts, scatter
| charts, and bubble charts in polar coordinates using the WebGL
| plotting engine. The data visualized as scatter point or lines
| is set in `r` (radial) and `theta` (angular) coordinates Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolargl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolargl.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolargl.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolargl.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolargl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolargl.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolargl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_scattersmith(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scattersmith trace
|
| The scattersmith trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in smith coordinates.
| The data visualized as scatter point or lines is set in `real`
| and `imag` (imaginary) coordinates Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scattersmith has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattersmith.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| imagsrc
| Sets the source reference on Chart Studio Cloud for
| `imag`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattersmith.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattersmith.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattersmith.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| real
| Sets the real component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| realsrc
| Sets the source reference on Chart Studio Cloud for
| `real`.
| selected
| :class:`plotly.graph_objects.scattersmith.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattersmith.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a smith subplot. If "smith" (the default value),
| the data refer to `layout.smith`. If "smith2", the data
| refer to `layout.smith2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `real`, `imag` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattersmith.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Scatterternary trace
|
| Provides similar functionality to the "scatter" type but on a
| ternary phase diagram. The data is provided by at least two
| arrays out of `a`, `b`, `c` triplets.
|
| Parameters
| ----------
| a
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on Chart Studio Cloud for
| `c`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterternary.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b,c)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b,c).
| To be seen, trace `hoverinfo` must contain a "text"
| flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterternary.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterternary.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterternary.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scatterternary.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterternary.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If "ternary" (the default
| value), the data refer to `layout.ternary`. If
| "ternary2", the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b`, `c` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterternary.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_selection(self, arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new selection to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Selection or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.layout.selection.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the selection.
| path
| For `type` "path" - a valid SVG path similar to
| `shapes.path` in data coordinates. Allowed segments
| are: M, L and Z.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the selection type to be drawn. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom
| SVG path using `path`.
| x0
| Sets the selection's starting x position.
| x1
| Sets the selection's end x position.
| xref
| Sets the selection's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y0
| Sets the selection's starting y position.
| y1
| Sets the selection's end y position.
| yref
| Sets the selection's x coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for selection. If 'all', addresses all rows
| in the specified column(s).
| col
| Subplot column for selection. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add selection to secondary y-axis
| exclude_empty_subplots
| If True, selection will not be added to subplots
| without traces.
|
| Returns
| -------
| Figure
|
| add_shape(self, arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'Figure'
| Create and add a new shape to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Shape or dict with compatible properties
| editable
| Determines whether the shape could be activated for
| edit or not. Has no effect when the older editable
| shapes mode is enabled via `config.editable` or
| `config.edits.shapePosition`.
| fillcolor
| Sets the color filling the shape's interior. Only
| applies to closed shapes.
| fillrule
| Determines which regions of complex paths constitute
| the interior. For more info please visit
| https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.shape.Label`
| instance or dict with compatible properties
| layer
| Specifies whether shapes are drawn below gridlines
| ("below"), between gridlines and traces ("between") or
| above traces ("above").
| legend
| Sets the reference to a legend to show this shape in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this shape. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.shape.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this shape. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this shape.
| line
| :class:`plotly.graph_objects.layout.shape.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the shape.
| path
| For `type` "path" - a valid SVG path with the pixel
| values replaced by data values in
| `xsizemode`/`ysizemode` being "scaled" and taken
| unmodified as pixels relative to `xanchor` and
| `yanchor` in case of "pixel" size mode. There are a few
| restrictions / quirks only absolute instructions, not
| relative. So the allowed segments are: M, L, H, V, Q,
| C, T, S, and Z arcs (A) are not allowed because radius
| rx and ry are relative. In the future we could consider
| supporting relative commands, but we would have to
| decide on how to handle date and log axes. Note that
| even as is, Q and C Bezier paths that are smooth on
| linear axes may not be smooth on log, and vice versa.
| no chained "polybezier" commands - specify the segment
| type for each one. On category axes, values are numbers
| scaled to the serial numbers of categories because
| using the categories themselves there would be no way
| to describe fractional positions On data axes: because
| space and T are both normal components of path strings,
| we can't use either to separate date from time parts.
| Therefore we'll use underscore for this purpose:
| 2015-02-21_13:45:56.789
| showlegend
| Determines whether or not this shape is shown in the
| legend.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the shape type to be drawn. If "line", a line
| is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect
| to the axes' sizing mode. If "circle", a circle is
| drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius
| (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with
| respect to the axes' sizing mode. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to
| the axes' sizing mode. If "path", draw a custom SVG
| path using `path`. with respect to the axes' sizing
| mode.
| visible
| Determines whether or not this shape is visible. If
| "legendonly", the shape is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Sets the shape's starting x position. See `type` and
| `xsizemode` for more info.
| x0shift
| Shifts `x0` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| x1
| Sets the shape's end x position. See `type` and
| `xsizemode` for more info.
| x1shift
| Shifts `x1` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| xanchor
| Only relevant in conjunction with `xsizemode` set to
| "pixel". Specifies the anchor point on the x axis to
| which `x0`, `x1` and x coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `xsizemode` not
| set to "pixel".
| xref
| Sets the shape's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xsizemode
| Sets the shapes's sizing mode along the x axis. If set
| to "scaled", `x0`, `x1` and x coordinates within `path`
| refer to data values on the x axis or a fraction of the
| plot area's width (`xref` set to "paper"). If set to
| "pixel", `xanchor` specifies the x position in terms of
| data or plot fraction but `x0`, `x1` and x coordinates
| within `path` are pixels relative to `xanchor`. This
| way, the shape can have a fixed width while maintaining
| a position relative to data or plot fraction.
| y0
| Sets the shape's starting y position. See `type` and
| `ysizemode` for more info.
| y0shift
| Shifts `y0` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| y1
| Sets the shape's end y position. See `type` and
| `ysizemode` for more info.
| y1shift
| Shifts `y1` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| yanchor
| Only relevant in conjunction with `ysizemode` set to
| "pixel". Specifies the anchor point on the y axis to
| which `y0`, `y1` and y coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `ysizemode` not
| set to "pixel".
| yref
| Sets the shape's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| ysizemode
| Sets the shapes's sizing mode along the y axis. If set
| to "scaled", `y0`, `y1` and y coordinates within `path`
| refer to data values on the y axis or a fraction of the
| plot area's height (`yref` set to "paper"). If set to
| "pixel", `yanchor` specifies the y position in terms of
| data or plot fraction but `y0`, `y1` and y coordinates
| within `path` are pixels relative to `yanchor`. This
| way, the shape can have a fixed height while
| maintaining a position relative to data or plot
| fraction.
| row
| Subplot row for shape. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for shape. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add shape to secondary y-axis
| exclude_empty_subplots
| If True, shape will not be added to subplots without
| traces.
|
| Returns
| -------
| Figure
|
| add_splom(self, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Splom trace
|
| Splom traces generate scatter plot matrix visualizations. Each
| splom `dimensions` items correspond to a generated axis. Values
| for each of those dimensions are set in `dimensions[i].values`.
| Splom traces support all `scattergl` marker style attributes.
| Specify `layout.grid` attributes and/or layout x-axis and
| y-axis attributes for more control over the axis positioning
| and style.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| diagonal
| :class:`plotly.graph_objects.splom.Diagonal` instance
| or dict with compatible properties
| dimensions
| A tuple of
| :class:`plotly.graph_objects.splom.Dimension` instances
| or dicts with compatible properties
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the
| default property values to use for elements of
| splom.dimensions
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.splom.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.splom.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.splom.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.splom.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showlowerhalf
| Determines whether or not subplots on the lower half
| from the diagonal are displayed.
| showupperhalf
| Determines whether or not subplots on the upper half
| from the diagonal are displayed.
| stream
| :class:`plotly.graph_objects.splom.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair to
| appear on hover. If a single string, the same string
| appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.splom.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxes
| Sets the list of x axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N xaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| yaxes
| Sets the list of y axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N yaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_streamtube(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Streamtube trace
|
| Use a streamtube trace to visualize flow in a vector field.
| Specify a vector field using 6 1D arrays of equal length, 3
| position arrays `x`, `y` and `z` and 3 vector component arrays
| `u`, `v`, and `w`. By default, the tubes' starting positions
| will be cut from the vector field's x-z plane at its minimum y
| value. To specify your own starting position, use attributes
| `starts.x`, `starts.y` and `starts.z`. The color is encoded by
| the norm of (u, v, w), and the local radius by the divergence
| of (u, v, w).
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.streamtube.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.streamtube.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `tubex`, `tubey`, `tubez`, `tubeu`,
| `tubev`, `tubew`, `norm` and `divergence`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.streamtube.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.streamtube.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.streamtube.Lightposition`
| instance or dict with compatible properties
| maxdisplayed
| The maximum number of displayed segments in a
| streamtube.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizeref
| The scaling factor for the streamtubes. The default is
| 1, which avoids two max divergence tubes from touching
| at adjacent starting positions.
| starts
| :class:`plotly.graph_objects.streamtube.Starts`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.streamtube.Stream`
| instance or dict with compatible properties
| text
| Sets a text element associated with this trace. If
| trace `hoverinfo` contains a "text" flag, this text
| element will be seen in all hover labels. Note that
| streamtube traces do not support array `text` values.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_sunburst(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Sunburst trace
|
| Visualize hierarchal data spanning outward radially from root
| to leaves. The sunburst sectors are determined by the entries
| in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sunburst.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.sunburst.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.sunburst.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sunburst.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.sunburst.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented at the center of a sunburst graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| root
| :class:`plotly.graph_objects.sunburst.Root` instance or
| dict with compatible properties
| rotation
| Rotates the whole diagram counterclockwise by some
| angle. By default the first slice starts at 3 o'clock.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.sunburst.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_surface(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Surface trace
|
| The data the describes the coordinates of the surface is set in
| `z`. Data in `z` should be a 2D list. Coordinates in `x` and
| `y` can either be 1D lists or 2D lists (e.g. to graph
| parametric surfaces). If not provided in `x` and `y`, the x and
| y coordinates are assumed to be linear starting at 0 with a
| unit step. The color scale corresponds to the `z` values by
| default. For custom color scales, use `surfacecolor` which
| should be a 2D list, where its bounds can be controlled using
| `cmin` and `cmax`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here z or surfacecolor)
| or the bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as z or surfacecolor.
| Has no effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmax` must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.surface.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| :class:`plotly.graph_objects.surface.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hidesurface
| Determines whether or not a surface is drawn. For
| example, set `hidesurface` to False `contours.x.show`
| to True and `contours.y.show` to True to draw a wire
| frame plot.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.surface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.surface.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.surface.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.surface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.surface.Stream` instance
| or dict with compatible properties
| surfacecolor
| Sets the surface color values, used for setting a color
| scale independent of `z`.
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
| text
| Sets the text elements associated with each z value. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| 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, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Table trace
|
| Table view for detailed data viewing. The data are arranged in
| a grid of rows and columns. Most styling can be specified for
| columns, rows or individual cells. Table is using a column-
| major order, ie. the grid is represented as a vector of column
| vectors.
|
| Parameters
| ----------
| cells
| :class:`plotly.graph_objects.table.Cells` instance or
| dict with compatible properties
| columnorder
| Specifies the rendered order of the data columns; for
| example, a value `2` at position `0` means that column
| index `0` in the data will be rendered as the third
| column, as columns have an index base of zero.
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
| columnwidth
| The width of columns expressed as a ratio. Columns fill
| the available width in proportion of their specified
| column widths.
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.table.Domain` instance or
| dict with compatible properties
| header
| :class:`plotly.graph_objects.table.Header` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.table.Hoverlabel` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.table.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| stream
| :class:`plotly.graph_objects.table.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_trace(self, trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) -> 'Figure'
| 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 : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
| * The trace argument is a 2D cartesian trace
| (scatter, bar, etc.)
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
| Returns
| -------
| BaseFigure
| The Figure that add_trace was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS
| Figure(...)
|
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) # doctest: +ELLIPSIS
| Figure(...)
|
| add_traces(self, data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) -> 'Figure'
| Add traces to the figure
|
| Parameters
| ----------
| data : list[BaseTraceType or dict]
| A list of trace specifications to be added.
| Trace specifications may be either:
|
| - Instances of trace classes from the plotly.graph_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, list[int], or int (default None)
| List of subplot row indexes (starting from 1) for the traces to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to row number
|
| cols : None or list[int] (default None)
| List of subplot column indexes (starting from 1) for the traces
| to be added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to column number
|
|
| secondary_ys: None or list[boolean] (default None)
| List of secondary_y booleans for traces to be added. See the
| docstring for `add_trace` for more info.
|
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
|
| Returns
| -------
| BaseFigure
| The Figure that add_traces was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])]) # doctest: +ELLIPSIS
| Figure(...)
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
| ... go.Scatter(x=[1,2,3], y=[2,1,2])],
| ... rows=[1, 2], cols=[1, 1]) # doctest: +ELLIPSIS
| Figure(...)
|
| add_treemap(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Treemap trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The treemap sectors are
| determined by the entries in "labels" or "ids" and in
| "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.treemap.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.treemap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.treemap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.treemap.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.treemap.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.treemap.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.treemap.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.treemap.Tiling` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_violin(self, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Violin trace
|
| In vertical (horizontal) violin plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| violin per distinct x (y) value is drawn If no `x` (`y`) list
| is provided, a single violin is drawn. That violin position is
| then positioned with with `name` or with `x0` (`y0`) if
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| bandwidth
| Sets the bandwidth used to compute the kernel density
| estimate. By default, the bandwidth is determined by
| Silverman's rule of thumb.
| box
| :class:`plotly.graph_objects.violin.Box` instance or
| dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.violin.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual violins or
| sample points or the kernel density estimate or any
| combination of them?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the violins.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.violin.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.violin.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.violin.Marker` instance or
| dict with compatible properties
| meanline
| :class:`plotly.graph_objects.violin.Meanline` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For violin traces, the name
| will also be used for the position coordinate, if `x`
| and `x0` (`y` and `y0` if horizontal) are missing and
| the position axis is categorical. Note that the trace
| name is also used as a default value for attribute
| `scalegroup` (please see its description for details).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the violin(s). If "v" ("h"),
| the distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the violins. If 0, the sample points are places over
| the center of the violins. Positive (negative) values
| correspond to positions to the right (left) for
| vertical violins and above (below) for horizontal
| violins.
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the violins are shown with no sample
| points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set, otherwise defaults to "outliers".
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| scalegroup
| If there are multiple violins that should be sized
| according to to some metric (see `scalemode`), link
| them by providing a non-empty group id here shared by
| every trace in the same group. If a violin's `width` is
| undefined, `scalegroup` will default to the trace's
| name. In this case, violins with the same names will be
| linked together
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same
| (max) width "count" means the violins are scaled by the
| number of sample points making up each violin.
| selected
| :class:`plotly.graph_objects.violin.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| side
| Determines on which side of the position value the
| density function making up one half of a violin is
| plotted. Useful when comparing two violin traces under
| "overlay" mode, where one trace has `side` set to
| "positive" and the other to "negative".
| span
| Sets the span in data space for which the density
| function will be computed. Has an effect only when
| `spanmode` is set to "manual".
| spanmode
| Sets the method by which the span in data space where
| the density function will be computed. "soft" means the
| span goes from the sample's minimum value minus two
| bandwidths to the sample's maximum value plus two
| bandwidths. "hard" means the span goes from the
| sample's minimum to its maximum value. For custom span
| settings, use mode "manual" and fill in the `span`
| attribute.
| stream
| :class:`plotly.graph_objects.violin.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.violin.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the width of the violin in data coordinates. If 0
| (default value) the width is automatically selected
| based on the positions of other violin traces in the
| same subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| add_vline(self, x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a vertical line to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x: float or int
| A number representing the x coordinate of the vertical line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_volume(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'Figure'
| Add a new Volume trace
|
| Draws volume trace between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.volume.Caps` instance or
| dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.volume.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.volume.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.volume.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.volume.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.volume.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.volume.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.volume.Slices` instance or
| dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.volume.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.volume.Stream` instance or
| dict with compatible properties
| surface
| :class:`plotly.graph_objects.volume.Surface` instance
| or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| Figure
|
| add_vrect(self, x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'Figure'
| Add a rectangle to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x0: float or int
| A number representing the x coordinate of one side of the rectangle.
| x1: float or int
| A number representing the x coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_waterfall(self, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Add a new Waterfall trace
|
| Draws waterfall trace which is useful graph to displays the
| contribution of various elements (either positive or negative)
| in a bar chart. The data visualized by the span of the bars is
| set in `y` if `orientation` is set to "v" (the default) and the
| labels are set in `x`. By setting `orientation` to "h", the
| roles are interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units).
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.waterfall.Connector`
| instance or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.waterfall.Decreasing`
| instance or dict with compatible properties
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.waterfall.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta` and `final`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.waterfall.Increasing`
| instance or dict with compatible properties
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.waterfall.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| measure
| An array containing types of values. By default the
| values are considered as 'relative'. However; it is
| possible to use 'total' to compute the sums. Also
| 'absolute' could be applied to reset the computed total
| or to declare an initial value where needed.
| measuresrc
| Sets the source reference on Chart Studio Cloud for
| `measure`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.waterfall.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple waterfalls, totals are
| computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta`, `final` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| totals
| :class:`plotly.graph_objects.waterfall.Totals` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| Figure
|
| for_each_annotation(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all annotations that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single annotation object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotations that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_coloraxis(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all coloraxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single coloraxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_geo(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all geo objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single geo object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_layout_image(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all images that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single image object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| images that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_legend(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all legend objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single legend object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_map(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all map objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single map object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_mapbox(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all mapbox objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single mapbox object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_polar(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all polar objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single polar object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_scene(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all scene objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single scene object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_selection(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all selections that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single selection object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selections that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_shape(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all shapes that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single shape object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shapes that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_smith(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all smith objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single smith object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_ternary(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all ternary objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single ternary object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_trace(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'Figure'
| Apply a function to all traces that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single trace object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_xaxis(self, fn, selector=None, row=None, col=None) -> 'Figure'
| Apply a function to all xaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single xaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'Figure'
| Apply a function to all yaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single yaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| select_annotations(self, selector=None, row=None, col=None, secondary_y=None)
| Select annotations from a particular subplot cell and/or annotations
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the annotations that satisfy
| all of the specified selection criteria
|
| select_coloraxes(self, selector=None, row=None, col=None)
| Select coloraxis subplot objects from a particular subplot cell
| and/or coloraxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the coloraxis
| objects that satisfy all of the specified selection criteria
|
| select_geos(self, selector=None, row=None, col=None)
| Select geo subplot objects from a particular subplot cell
| and/or geo subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the geo
| objects that satisfy all of the specified selection criteria
|
| select_layout_images(self, selector=None, row=None, col=None, secondary_y=None)
| Select images from a particular subplot cell and/or images
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the images that satisfy
| all of the specified selection criteria
|
| select_legends(self, selector=None, row=None, col=None)
| Select legend subplot objects from a particular subplot cell
| and/or legend subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the legend
| objects that satisfy all of the specified selection criteria
|
| select_mapboxes(self, selector=None, row=None, col=None)
| Select mapbox subplot objects from a particular subplot cell
| and/or mapbox subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the mapbox
| objects that satisfy all of the specified selection criteria
|
| select_maps(self, selector=None, row=None, col=None)
| Select map subplot objects from a particular subplot cell
| and/or map subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the map
| objects that satisfy all of the specified selection criteria
|
| select_polars(self, selector=None, row=None, col=None)
| Select polar subplot objects from a particular subplot cell
| and/or polar subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the polar
| objects that satisfy all of the specified selection criteria
|
| select_scenes(self, selector=None, row=None, col=None)
| Select scene subplot objects from a particular subplot cell
| and/or scene subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the scene
| objects that satisfy all of the specified selection criteria
|
| select_selections(self, selector=None, row=None, col=None, secondary_y=None)
| Select selections from a particular subplot cell and/or selections
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the selections that satisfy
| all of the specified selection criteria
|
| select_shapes(self, selector=None, row=None, col=None, secondary_y=None)
| Select shapes from a particular subplot cell and/or shapes
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the shapes that satisfy
| all of the specified selection criteria
|
| select_smiths(self, selector=None, row=None, col=None)
| Select smith subplot objects from a particular subplot cell
| and/or smith subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the smith
| objects that satisfy all of the specified selection criteria
|
| select_ternaries(self, selector=None, row=None, col=None)
| Select ternary subplot objects from a particular subplot cell
| and/or ternary subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the ternary
| objects that satisfy all of the specified selection criteria
|
| select_xaxes(self, selector=None, row=None, col=None)
| Select xaxis subplot objects from a particular subplot cell
| and/or xaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the xaxis
| objects that satisfy all of the specified selection criteria
|
| select_yaxes(self, selector=None, row=None, col=None, secondary_y=None)
| Select yaxis subplot objects from a particular subplot cell
| and/or yaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the yaxis
| objects that satisfy all of the specified selection criteria
|
| set_subplots(self, rows=None, cols=None, **make_subplots_args) -> 'Figure'
| Add subplots to this figure. If the figure already contains subplots,
| then this throws an error. Accepts any keyword arguments that
| plotly.subplots.make_subplots accepts.
|
| update(self, dict1=None, overwrite=False, **kwargs) -> 'Figure'
| Update the properties of the figure with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the figure
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Examples
| --------
| >>> import plotly.graph_objs as go
| >>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
| >>> fig.update(data=[{'y': [4, 5, 6]}]) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'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'}}}) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'data': [],
| 'layout': {'xaxis':
| {'color': 'pink',
| 'range': [0, 1]}}}
|
| Returns
| -------
| BaseFigure
| Updated figure
|
| update_annotations(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all annotations that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all annotations that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected annotation. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_coloraxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all coloraxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| coloraxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| coloraxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_geos(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all geo objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| geo objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| geo object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_layout(self, dict1=None, overwrite=False, **kwargs) -> 'Figure'
| Update the properties of the figure's layout with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| layout with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BaseFigure
| The Figure object that the update_layout method was called on
|
| update_layout_images(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all images that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all images that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected image. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_legends(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all legend objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| legend objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| legend object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_mapboxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all mapbox objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| mapbox objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| mapbox object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_maps(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all map objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| map objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| map object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_polars(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all polar objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| polar objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| polar object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_scenes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all scene objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| scene objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| scene object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_selections(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all selections that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all selections that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected selection. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_shapes(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all shapes that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all shapes that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected shape. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_smiths(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all smith objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| smith objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| smith object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_ternaries(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all ternary objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| ternary objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| ternary object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_traces(self, patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) -> 'Figure'
| Perform a property update operation on all traces that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all traces that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| **kwargs
| Additional property updates to apply to each selected trace. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_xaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'Figure'
| Perform a property update operation on all xaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| xaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| xaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_yaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) -> 'Figure'
| Perform a property update operation on all yaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| yaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected
| yaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFigure:
|
| __contains__(self, prop)
|
| __eq__(self, other)
| Return self==value.
|
| __getitem__(self, prop)
|
| __iter__(self)
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __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)
|
| 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(self, duration=500, easing='cubic-in-out')
| 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_animate(duration=2000, easing='elastic-in-out'):
| ... fig.data[0].marker.color = 'green'
| ... fig.data[0].marker.size = 20
|
| batch_update(self)
| 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.
|
| full_figure_for_development(self, warn=True, as_dict=False)
| Compute default values for all attributes not specified in the input figure and
| returns the output as a "full" figure. This function calls Plotly.js via Kaleido
| to populate unspecified attributes. This function is intended for interactive use
| during development to learn more about how Plotly.js computes default values and is
| not generally necessary or recommended for production use.
|
| Parameters
| ----------
| fig:
| Figure object or dict representing a figure
|
| warn: bool
| If False, suppress warnings about not using this in production.
|
| as_dict: bool
| If True, output is a dict with some keys that go.Figure can't parse.
| If False, output is a go.Figure with unparseable keys skipped.
|
| Returns
| -------
| plotly.graph_objects.Figure or dict
| The full figure
|
| get_subplot(self, row, col, secondary_y=False)
| Return an object representing the subplot at the specified row
| and column. May only be used on Figures created using
| plotly.tools.make_subplots
|
| Parameters
| ----------
| row: int
| 1-based index of subplot row
| col: int
| 1-based index of subplot column
| secondary_y: bool
| If True, select the subplot that consists of the x-axis and the
| secondary y-axis at the specified row/col. Only valid if the
| subplot at row/col is an 2D cartesian subplot that was created
| with a secondary y-axis. See the docstring for the specs argument
| to make_subplots for more info on creating a subplot with a
| secondary y-axis.
| Returns
| -------
| subplot
| * None: if subplot is empty
| * plotly.graph_objs.layout.Scene: if subplot type is 'scene'
| * plotly.graph_objs.layout.Polar: if subplot type is 'polar'
| * plotly.graph_objs.layout.Ternary: if subplot type is 'ternary'
| * plotly.graph_objs.layout.Mapbox: if subplot type is 'ternary'
| * SubplotDomain namedtuple with `x` and `y` fields:
| if subplot type is 'domain'.
| - x: length 2 list of the subplot start and stop width
| - y: length 2 list of the subplot start and stop height
| * SubplotXY namedtuple with `xaxis` and `yaxis` fields:
| if subplot type is 'xy'.
| - xaxis: plotly.graph_objs.layout.XAxis instance for subplot
| - yaxis: plotly.graph_objs.layout.YAxis instance for subplot
|
| 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]
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[2, 4, 6]))
| >>> 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
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in figure
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| 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.
|
| select_traces(self, selector=None, row=None, col=None, secondary_y=None)
| Select traces from a particular subplot cell and/or traces
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the traces that satisfy
| all of the specified selection criteria
|
| show(self, *args, **kwargs)
| Show a figure using either the default renderer(s) or the renderer(s)
| specified by the renderer argument
|
| Parameters
| ----------
| renderer: str or None (default None)
| A string containing the names of one or more registered renderers
| (separated by '+' characters) or None. If None, then the default
| renderers specified in plotly.io.renderers.default are used.
|
| validate: bool (default True)
| True if the figure should be validated before being shown,
| False otherwise.
|
| width: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| height: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| config: dict
| A dict of parameters to configure the figure. The defaults are set
| in plotly.js.
|
| Returns
| -------
| None
|
| 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_html(self, *args, **kwargs)
| Convert a figure to an HTML string representation.
|
| Parameters
| ----------
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| str
| Representation of figure as an HTML div string
|
| to_image(self, *args, **kwargs)
| Convert a figure to a static image bytes string
|
| Parameters
| ----------
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified, will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
|
| Returns
| -------
| bytes
| The image data
|
| to_json(self, *args, **kwargs)
| Convert a figure to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of figure as a JSON string
|
| to_ordered_dict(self, skip_uid=True)
|
| to_plotly_json(self)
| Convert figure to a JSON representation as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| write_html(self, *args, **kwargs)
| Write a figure to an HTML file representation
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file. If `file` is a string to a local file
| path and `full_html` is True, then the plotly.min.js bundle is copied
| into the directory of the resulting HTML file. If a file named
| plotly.min.js already exists in the output directory then this file
| is left unmodified and no copy is performed. HTML files generated
| with this option can be used offline, but they require a copy of
| the plotly.min.js bundle in the same directory. This option is
| useful when many figures will be saved as HTML files in the same
| directory because the plotly.js source code will be included only
| once per output directory, rather than once per output file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
|
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| auto_open: bool (default True)
| If True, open the saved file in a web browser after saving.
| This argument only applies if `full_html` is True.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| None
|
| write_image(self, *args, **kwargs)
| Convert a figure to a static image and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
|
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified and `file` is a string then this will default to the
| file extension. If not specified and `file` is not a string then this
| will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
| Returns
| -------
| None
|
| write_json(self, *args, **kwargs)
| Convert a figure to JSON and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. an open file descriptor)
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| None
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BaseFigure:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| data
| The `data` property is a tuple of the figure's trace objects
|
| Returns
| -------
| tuple[BaseTraceType]
|
| frames
| The `frames` property is a tuple of the figure's frame objects
|
| Returns
| -------
| tuple[plotly.graph_objs.Frame]
|
| layout
| The `layout` property of the figure
|
| Returns
| -------
| plotly.graph_objs.Layout
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BaseFigure:
|
| __hash__ = None
class FigureWidget(plotly.basewidget.BaseFigureWidget)
| FigureWidget(data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
|
| 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
| builtins.object
|
| Methods defined here:
|
| __init__(self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs)
| Create a new :class: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 single trace instance
| (e.g. Scatter(...), Bar(...), etc.)
| - A list or tuple of dicts of string/value properties where:
| - The 'type' property specifies the trace type
| One of: ['bar', 'barpolar', 'box', 'candlestick',
| 'carpet', 'choropleth', 'choroplethmap',
| 'choroplethmapbox', 'cone', 'contour',
| 'contourcarpet', 'densitymap',
| 'densitymapbox', 'funnel', 'funnelarea',
| 'heatmap', 'heatmapgl', 'histogram',
| 'histogram2d', 'histogram2dcontour', 'icicle',
| 'image', 'indicator', 'isosurface', 'mesh3d',
| 'ohlc', 'parcats', 'parcoords', 'pie',
| 'pointcloud', 'sankey', 'scatter',
| 'scatter3d', 'scattercarpet', 'scattergeo',
| 'scattergl', 'scattermap', 'scattermapbox',
| 'scatterpolar', 'scatterpolargl',
| 'scattersmith', 'scatterternary', 'splom',
| 'streamtube', 'sunburst', 'surface', 'table',
| 'treemap', 'violin', 'volume', 'waterfall']
|
| - 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 :class:`plotly.graph_objs.Layout`
| - A dict of string/value properties that will be passed
| to the Layout constructor
|
| Supported dict properties:
|
| activeselection
| :class:`plotly.graph_objects.layout.Activeselec
| tion` instance or dict with compatible
| properties
| activeshape
| :class:`plotly.graph_objects.layout.Activeshape
| ` instance or dict with compatible properties
| annotations
| A tuple of
| :class:`plotly.graph_objects.layout.Annotation`
| instances or dicts with compatible properties
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults),
| sets the default property values to use for
| elements of layout.annotations
| 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.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. This is the default value;
| however it could be overridden for individual
| axes.
| barcornerradius
| Sets the rounding of bar corners. May be an
| integer number of pixels, or a percentage of
| bar width (as a string ending in %).
| 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 reduce "opacity" to
| see multiple bars.
| barnorm
| Sets the normalization for bar traces on the
| graph. With "fraction", the value of each bar
| is divided by the sum of all values at that
| location coordinate. "percent" is the same but
| multiplied by 100 to show percentages.
| boxgap
| Sets the gap (in plot fraction) between boxes
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| boxmode
| Determines how boxes at the same location
| coordinate are displayed on the graph. If
| "group", the boxes are plotted next to one
| another centered around the shared location. If
| "overlay", the boxes are plotted over one
| another, you might need to set "opacity" to see
| them multiple boxes. Has no effect on traces
| that have "width" set.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout
| the plot.
| clickmode
| Determines the mode of single click
| interactions. "event" is the default value and
| emits the `plotly_click` event. In addition
| this mode emits the `plotly_selected` event in
| drag modes "lasso" and "select", but with no
| event data attached (kept for compatibility
| reasons). The "select" flag enables selecting
| single data points via click. This mode also
| supports persistent selections, meaning that
| pressing Shift while clicking, adds to /
| subtracts from an existing selection. "select"
| with `hovermode`: "x" can be confusing,
| consider explicitly setting `hovermode`:
| "closest" when using this feature. Selection
| events are sent accordingly as long as "event"
| flag is set as well. When the "event" flag is
| missing, `plotly_click` and `plotly_selected`
| events are not fired.
| coloraxis
| :class:`plotly.graph_objects.layout.Coloraxis`
| instance or dict with compatible properties
| colorscale
| :class:`plotly.graph_objects.layout.Colorscale`
| instance or dict with compatible properties
| colorway
| Sets the default trace colors.
| computed
| Placeholder for exporting automargin-impacting
| values namely `margin.t`, `margin.b`,
| `margin.l` and `margin.r` in "full-json" mode.
| 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.
| 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.
| editrevision
| Controls persistence of user-driven changes in
| `editable: true` configuration, other than
| trace names and axis titles. Defaults to
| `layout.uirevision`.
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether
| given by `funnelareacolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendiciclecolors
| If `true`, the icicle slice colors (whether
| given by `iciclecolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendpiecolors
| If `true`, the pie slice colors (whether given
| by `piecolorway` or inherited from `colorway`)
| will be extended to three times its original
| length by first repeating every color 20%
| lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether
| given by `sunburstcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| extendtreemapcolors
| If `true`, the treemap slice colors (whether
| given by `treemapcolorway` or inherited from
| `colorway`) will be extended to three times its
| original length by first repeating every color
| 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing
| the same color when you have many slices, but
| you can set `false` to disable. Colors provided
| in the trace, using `marker.colors`, are never
| extended.
| font
| Sets the global font. Note that fonts used in
| traces and other layout components inherit from
| the global font.
| funnelareacolorway
| Sets the default funnelarea slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendfunnelareacolors`.
| funnelgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| funnelmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "stack", the bars are stacked on top of one
| another With "group", the bars are plotted next
| to one another centered around the shared
| location. With "overlay", the bars are plotted
| over one another, you might need to reduce
| "opacity" to see multiple bars.
| geo
| :class:`plotly.graph_objects.layout.Geo`
| instance or dict with compatible properties
| grid
| :class:`plotly.graph_objects.layout.Grid`
| instance or dict with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart
| analog of visible:'legendonly' but it can
| contain many labels, and can simultaneously
| hide slices from several pies/funnelarea charts
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud
| 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 Chart Studio Cloud (at
| https://chart-studio.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
| :class:`plotly.graph_objects.layout.Hoverlabel`
| instance or dict with compatible properties
| hovermode
| Determines the mode of hover interactions. If
| "closest", a single hoverlabel will appear for
| the "closest" point within the `hoverdistance`.
| If "x" (or "y"), multiple hoverlabels will
| appear for multiple points at the "closest" x-
| (or y-) coordinate within the `hoverdistance`,
| with the caveat that no more than one
| hoverlabel will appear per trace. If *x
| unified* (or *y unified*), a single hoverlabel
| will appear multiple points at the closest x-
| (or y-) coordinate within the `hoverdistance`
| with the caveat that no more than one
| hoverlabel will appear per trace. In this mode,
| spikelines are enabled by default perpendicular
| to the specified axis. If false, hover
| interactions are disabled.
| hoversubplots
| Determines expansion of hover effects to other
| subplots If "single" just the axis pair of the
| primary point is included without overlaying
| subplots. If "overlaying" all subplots using
| the main axis and occupying the same space are
| included. If "axis", also include stacked
| subplots using the same axis when `hovermode`
| is set to "x", *x unified*, "y" or *y unified*.
| iciclecolorway
| Sets the default icicle slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendiciclecolors`.
| images
| A tuple of
| :class:`plotly.graph_objects.layout.Image`
| instances or dicts with compatible properties
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the
| default property values to use for elements of
| layout.images
| legend
| :class:`plotly.graph_objects.layout.Legend`
| instance or dict with compatible properties
| map
| :class:`plotly.graph_objects.layout.Map`
| instance or dict with compatible properties
| mapbox
| :class:`plotly.graph_objects.layout.Mapbox`
| instance or dict with compatible properties
| margin
| :class:`plotly.graph_objects.layout.Margin`
| instance or dict with compatible properties
| meta
| Assigns extra meta information that can be used
| in various `text` attributes. Attributes such
| as the graph, axis and colorbar `title.text`,
| annotation `text` `trace.name` in legend items,
| `rangeselector`, `updatemenus` and `sliders`
| `label` text all support `meta`. One can access
| `meta` fields using template strings:
| `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an
| object for example `{key: value}` which can be
| accessed %{meta[key]}.
| metasrc
| Sets the source reference on Chart Studio Cloud
| for `meta`.
| minreducedheight
| Minimum height of the plot with
| margin.automargin applied (in px)
| minreducedwidth
| Minimum width of the plot with
| margin.automargin applied (in px)
| modebar
| :class:`plotly.graph_objects.layout.Modebar`
| instance or dict with compatible properties
| newselection
| :class:`plotly.graph_objects.layout.Newselectio
| n` instance or dict with compatible properties
| newshape
| :class:`plotly.graph_objects.layout.Newshape`
| instance or dict with compatible properties
| paper_bgcolor
| Sets the background color of the paper where
| the graph is drawn.
| piecolorway
| Sets the default pie slice colors. Defaults to
| the main `colorway` used for trace colors. If
| you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendpiecolors`.
| plot_bgcolor
| Sets the background color of the plotting area
| in-between x and y axes.
| polar
| :class:`plotly.graph_objects.layout.Polar`
| instance or dict with compatible properties
| scattergap
| Sets the gap (in plot fraction) between scatter
| points of adjacent location coordinates.
| Defaults to `bargap`.
| scattermode
| Determines how scatter points at the same
| location coordinate are displayed on the graph.
| With "group", the scatter points are plotted
| next to one another centered around the shared
| location. With "overlay", the scatter points
| are plotted over one another, you might need to
| reduce "opacity" to see multiple scatter
| points.
| scene
| :class:`plotly.graph_objects.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.
| selectionrevision
| Controls persistence of user-driven changes in
| selected points from all traces.
| selections
| A tuple of
| :class:`plotly.graph_objects.layout.Selection`
| instances or dicts with compatible properties
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets
| the default property values to use for elements
| of layout.selections
| 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
| A tuple of
| :class:`plotly.graph_objects.layout.Shape`
| instances or dicts with compatible properties
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the
| default property values to use for elements of
| layout.shapes
| showlegend
| Determines whether or not a legend is drawn.
| Default is `true` if there is a trace to show
| and any of these: a) Two or more traces would
| by default be shown in the legend. b) One pie
| trace is shown in the legend. c) One trace is
| explicitly given with `showlegend: true`.
| sliders
| A tuple of
| :class:`plotly.graph_objects.layout.Slider`
| instances or dicts with compatible properties
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets
| the default property values to use for elements
| of layout.sliders
| smith
| :class:`plotly.graph_objects.layout.Smith`
| 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.
| sunburstcolorway
| Sets the default sunburst slice colors.
| Defaults to the main `colorway` used for trace
| colors. If you specify a new list here it can
| still be extended with lighter and darker
| colors, see `extendsunburstcolors`.
| template
| Default attributes to be applied to the plot.
| This should be a dict with format: `{'layout':
| layoutTemplate, 'data': {trace_type:
| [traceTemplate, ...], ...}}` where
| `layoutTemplate` is a dict matching the
| structure of `figure.layout` and
| `traceTemplate` is a dict matching the
| structure of the trace with type `trace_type`
| (e.g. 'scatter'). Alternatively, this may be
| specified as an instance of
| plotly.graph_objs.layout.Template. Trace
| templates are applied cyclically to traces of
| each type. Container arrays (eg `annotations`)
| have special handling: An object ending in
| `defaults` (eg `annotationdefaults`) is applied
| to each array item. But if an item has a
| `templateitemname` key we look in the template
| array for an item with matching `name` and
| apply that instead. If no matching `name` is
| found we mark the item invisible. Any named
| template item not referenced is appended to the
| end of the array, so this can be used to add a
| watermark annotation or a logo image, for
| example. To omit one of these items on the
| plot, make an item with matching
| `templateitemname` and `visible: false`.
| ternary
| :class:`plotly.graph_objects.layout.Ternary`
| instance or dict with compatible properties
| title
| :class:`plotly.graph_objects.layout.Title`
| instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.title.font
| instead. Sets the title font. Note that the
| title's font used to be customized by the now
| deprecated `titlefont` attribute.
| transition
| Sets transition options used during
| Plotly.react updates.
| treemapcolorway
| Sets the default treemap slice colors. Defaults
| to the main `colorway` used for trace colors.
| If you specify a new list here it can still be
| extended with lighter and darker colors, see
| `extendtreemapcolors`.
| uirevision
| Used to allow user interactions with the plot
| to persist after `Plotly.react` calls that are
| unaware of these interactions. If `uirevision`
| is omitted, or if it is given and it changed
| from the previous `Plotly.react` call, the
| exact new figure is used. If `uirevision` is
| truthy and did NOT change, any attribute that
| has been affected by user interactions and did
| not receive a different value in the new figure
| will keep the interaction value.
| `layout.uirevision` attribute serves as the
| default for `uirevision` attributes in various
| sub-containers. For finer control you can set
| these sub-attributes directly. For example, if
| your app separately controls the data on the x
| and y axes you might set
| `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y
| data is changed, you can update
| `yaxis.uirevision=*quantity*` and the y axis
| range will reset but the x axis range will
| retain any user-driven zoom.
| uniformtext
| :class:`plotly.graph_objects.layout.Uniformtext
| ` instance or dict with compatible properties
| updatemenus
| A tuple of
| :class:`plotly.graph_objects.layout.Updatemenu`
| instances or dicts with compatible properties
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults),
| sets the default property values to use for
| elements of layout.updatemenus
| violingap
| Sets the gap (in plot fraction) between violins
| of adjacent location coordinates. Has no effect
| on traces that have "width" set.
| violingroupgap
| Sets the gap (in plot fraction) between violins
| of the same location coordinate. Has no effect
| on traces that have "width" set.
| violinmode
| Determines how violins at the same location
| coordinate are displayed on the graph. If
| "group", the violins are plotted next to one
| another centered around the shared location. If
| "overlay", the violins are plotted over one
| another, you might need to set "opacity" to see
| them multiple violins. Has no effect on traces
| that have "width" set.
| waterfallgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of
| the same location coordinate.
| waterfallmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "group", the bars are plotted next to one
| another centered around the shared location.
| With "overlay", the bars are plotted over one
| another, you might need to reduce "opacity" to
| see multiple bars.
| width
| Sets the plot's width (in px).
| xaxis
| :class:`plotly.graph_objects.layout.XAxis`
| instance or dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.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
|
| skip_invalid: bool
| If True, invalid properties in the figure specification will be
| skipped silently. If False (default) invalid properties in the
| figure specification will result in a ValueError
|
| Raises
| ------
| ValueError
| if a property in the specification of data, layout, or frames
| is invalid AND skip_invalid is False
|
| add_annotation(self, arg=None, align=None, arrowcolor=None, arrowhead=None, arrowside=None, arrowsize=None, arrowwidth=None, ax=None, axref=None, ay=None, ayref=None, bgcolor=None, bordercolor=None, borderpad=None, borderwidth=None, captureevents=None, clicktoshow=None, font=None, height=None, hoverlabel=None, hovertext=None, name=None, opacity=None, showarrow=None, standoff=None, startarrowhead=None, startarrowsize=None, startstandoff=None, templateitemname=None, text=None, textangle=None, valign=None, visible=None, width=None, x=None, xanchor=None, xclick=None, xref=None, xshift=None, y=None, yanchor=None, yclick=None, yref=None, yshift=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new annotation to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Annotation or dict with compatible
| properties
| align
| Sets the horizontal alignment of the `text` within the
| box. Has an effect only if `text` spans two or more
| lines (i.e. `text` contains one or more <br> HTML tags)
| or if an explicit width is set to override the text
| width.
| arrowcolor
| Sets the color of the annotation arrow.
| arrowhead
| Sets the end annotation arrow head style.
| arrowside
| Sets the annotation arrow head position.
| arrowsize
| Sets the size of the end annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| arrowwidth
| Sets the width (in px) of annotation arrow line.
| ax
| Sets the x component of the arrow tail about the arrow
| head. If `axref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from right
| to left (left to right). If `axref` is not `pixel` and
| is exactly the same as `xref`, this is an absolute
| value on that axis, like `x`, specified in the same
| coordinates as `xref`.
| axref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a x axis id
| (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis. In order for absolute
| positioning of the arrow to work, "axref" must be
| exactly the same as "xref", otherwise "axref" will
| revert to "pixel" (explained next). For relative
| positioning, "axref" can be set to "pixel", in which
| case the "ax" value is specified in pixels relative to
| "x". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| ay
| Sets the y component of the arrow tail about the arrow
| head. If `ayref` is `pixel`, a positive (negative)
| component corresponds to an arrow pointing from bottom
| to top (top to bottom). If `ayref` is not `pixel` and
| is exactly the same as `yref`, this is an absolute
| value on that axis, like `y`, specified in the same
| coordinates as `yref`.
| ayref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a y axis id
| (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis. In order for absolute
| positioning of the arrow to work, "ayref" must be
| exactly the same as "yref", otherwise "ayref" will
| revert to "pixel" (explained next). For relative
| positioning, "ayref" can be set to "pixel", in which
| case the "ay" value is specified in pixels relative to
| "y". Absolute positioning is useful for trendline
| annotations which should continue to indicate the
| correct trend when zoomed. Relative positioning is
| useful for specifying the text offset for an annotated
| point.
| bgcolor
| Sets the background color of the annotation.
| bordercolor
| Sets the color of the border enclosing the annotation
| `text`.
| borderpad
| Sets the padding (in px) between the `text` and the
| enclosing border.
| borderwidth
| Sets the width (in px) of the border enclosing the
| annotation `text`.
| captureevents
| Determines whether the annotation text box captures
| mouse move and click events, or allows those events to
| pass through to data points in the plot that may be
| behind the annotation. By default `captureevents` is
| False unless `hovertext` is provided. If you use the
| event `plotly_clickannotation` without `hovertext` you
| must explicitly enable `captureevents`.
| clicktoshow
| Makes this annotation respond to clicks on the plot. If
| you click a data point that exactly matches the `x` and
| `y` values of this annotation, and it is hidden
| (visible: false), it will appear. In "onoff" mode, you
| must click the same point again to make it disappear,
| so if you click multiple points, you can show multiple
| annotations. In "onout" mode, a click anywhere else in
| the plot (on another data point or not) will hide this
| annotation. If you need to show/hide this annotation in
| response to different `x` or `y` values, you can set
| `xclick` and/or `yclick`. This is useful for example to
| label the side of a bar. To label markers though,
| `standoff` is preferred over `xclick` and `yclick`.
| font
| Sets the annotation text font.
| height
| Sets an explicit height for the text box. null
| (default) lets the text set the box height. Taller text
| will be clipped.
| hoverlabel
| :class:`plotly.graph_objects.layout.annotation.Hoverlab
| el` instance or dict with compatible properties
| hovertext
| Sets text to appear when hovering over this annotation.
| If omitted or blank, no hover label will appear.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the annotation (text + arrow).
| showarrow
| Determines whether or not the annotation is drawn with
| an arrow. If True, `text` is placed near the arrow's
| tail. If False, `text` lines up with the `x` and `y`
| provided.
| standoff
| Sets a distance, in pixels, to move the end arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| startarrowhead
| Sets the start annotation arrow head style.
| startarrowsize
| Sets the size of the start annotation arrow head,
| relative to `arrowwidth`. A value of 1 (default) gives
| a head about 3x as wide as the line.
| startstandoff
| Sets a distance, in pixels, to move the start arrowhead
| away from the position it is pointing at, for example
| to point at the edge of a marker independent of zoom.
| Note that this shortens the arrow from the `ax` / `ay`
| vector, in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| text
| Sets the text associated with this annotation. Plotly
| uses a subset of HTML tags to do things like newline
| (<br>), bold (<b></b>), italics (<i></i>), hyperlinks
| (<a href='...'></a>). Tags <em>, <sup>, <sub>, <s>, <u>
| <span> are also supported.
| textangle
| Sets the angle at which the `text` is drawn with
| respect to the horizontal.
| valign
| Sets the vertical alignment of the `text` within the
| box. Has an effect only if an explicit height is set to
| override the text height.
| visible
| Determines whether or not this annotation is visible.
| width
| Sets an explicit width for the text box. null (default)
| lets the text set the box width. Wider text will be
| clipped. There is no automatic wrapping; use <br> to
| start a new line.
| x
| Sets the annotation's x position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| xanchor
| Sets the text box's horizontal position anchor This
| anchor binds the `x` position to the "left", "center"
| or "right" of the annotation. For example, if `x` is
| set to 1, `xref` to "paper" and `xanchor` to "right"
| then the right-most portion of the annotation lines up
| with the right-most edge of the plotting area. If
| "auto", the anchor is equivalent to "center" for data-
| referenced annotations or if there is an arrow, whereas
| for paper-referenced with no arrow, the anchor picked
| corresponds to the closest side.
| xclick
| Toggle this annotation when clicking a data point whose
| `x` value is `xclick` rather than the annotation's `x`
| value.
| xref
| Sets the annotation's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xshift
| Shifts the position of the whole annotation and arrow
| to the right (positive) or left (negative) by this many
| pixels.
| y
| Sets the annotation's y position. If the axis `type` is
| "log", then you must take the log of your desired
| range. If the axis `type` is "date", it should be date
| strings, like date data, though Date objects and unix
| milliseconds will be accepted and converted to strings.
| If the axis `type` is "category", it should be numbers,
| using the scale where each category is assigned a
| serial number from zero in the order it appears.
| yanchor
| Sets the text box's vertical position anchor This
| anchor binds the `y` position to the "top", "middle" or
| "bottom" of the annotation. For example, if `y` is set
| to 1, `yref` to "paper" and `yanchor` to "top" then the
| top-most portion of the annotation lines up with the
| top-most edge of the plotting area. If "auto", the
| anchor is equivalent to "middle" for data-referenced
| annotations or if there is an arrow, whereas for paper-
| referenced with no arrow, the anchor picked corresponds
| to the closest side.
| yclick
| Toggle this annotation when clicking a data point whose
| `y` value is `yclick` rather than the annotation's `y`
| value.
| yref
| Sets the annotation's y coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| yshift
| Shifts the position of the whole annotation and arrow
| up (positive) or down (negative) by this many pixels.
| row
| Subplot row for annotation. If 'all', addresses all
| rows in the specified column(s).
| col
| Subplot column for annotation. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add annotation to secondary y-axis
| exclude_empty_subplots
| If True, annotation will not be added to subplots
| without traces.
|
| Returns
| -------
| FigureWidget
|
| add_bar(self, alignmentgroup=None, base=None, basesrc=None, cliponaxis=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Bar trace
|
| The data visualized by the span of the bars is set in `y` if
| `orientation` is set to "v" (the default) and the labels are
| set in `x`. By setting `orientation` to "h", the roles are
| interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units). In "stack" or "relative" barmode, traces that
| set "base" will be excluded and drawn in "overlay" mode
| instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.bar.ErrorX` instance or
| dict with compatible properties
| error_y
| :class:`plotly.graph_objects.bar.ErrorY` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.bar.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`. Anything contained in
| tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.bar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.bar.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.bar.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.bar.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `value` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.bar.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_barpolar(self, base=None, basesrc=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetsrc=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textsrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, widthsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Barpolar trace
|
| The data visualized by the radial span of the bars is set in
| `r`
|
| Parameters
| ----------
| base
| Sets where the bar base is drawn (in radial axis
| units). In "stack" barmode, traces that set "base" will
| be excluded and drawn in "overlay" mode instead.
| basesrc
| Sets the source reference on Chart Studio Cloud for
| `base`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.barpolar.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.barpolar.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the angular position where the bar is drawn (in
| "thetatunit" units).
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.barpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.barpolar.Stream` instance
| or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.barpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar angular width (in "thetaunit" units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_box(self, alignmentgroup=None, boxmean=None, boxpoints=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lowerfence=None, lowerfencesrc=None, marker=None, mean=None, meansrc=None, median=None, mediansrc=None, meta=None, metasrc=None, name=None, notched=None, notchspan=None, notchspansrc=None, notchwidth=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, q1=None, q1src=None, q3=None, q3src=None, quartilemethod=None, sd=None, sdmultiple=None, sdsrc=None, selected=None, selectedpoints=None, showlegend=None, showwhiskers=None, sizemode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, upperfence=None, upperfencesrc=None, visible=None, whiskerwidth=None, width=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Box trace
|
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The
| second quartile (Q2, i.e. the median) is marked by a line
| inside the box. The fences grow outward from the boxes' edges,
| by default they span +/- 1.5 times the interquartile range
| (IQR: Q3-Q1), The sample mean and standard deviation as well as
| notches and the sample, outlier and suspected outliers points
| can be optionally added to the box plot. The values and
| positions corresponding to each boxes can be input using two
| signatures. The first signature expects users to supply the
| sample values in the `y` data array for vertical boxes (`x` for
| horizontal boxes). By supplying an `x` (`y`) array, one box per
| distinct `x` (`y`) value is drawn If no `x` (`y`) list is
| provided, a single box is drawn. In this case, the box is
| positioned with the trace `name` or with `x0` (`y0`) if
| provided. The second signature expects users to supply the
| boxes corresponding Q1, median and Q3 statistics in the `q1`,
| `median` and `q3` data arrays respectively. Other box features
| relying on statistics namely `lowerfence`, `upperfence`,
| `notchspan` can be set directly by the users. To have plotly
| compute them or to show sample points besides the boxes, users
| can set the `y` data array for vertical boxes (`x` for
| horizontal boxes) to a 2D array with the outer length
| corresponding to the number of boxes in the traces and the
| inner length corresponding the sample size.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| boxmean
| If True, the mean of the box(es)' underlying
| distribution is drawn as a dashed line inside the
| box(es). If "sd" the standard deviation is also drawn.
| Defaults to True when `mean` is set. Defaults to "sd"
| when `sd` is set Otherwise defaults to False.
| boxpoints
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the box(es) are shown with no sample
| points Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set. Defaults to "all" under the q1/median/q3
| signature. Otherwise defaults to "outliers".
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step for multi-box traces set
| using q1/median/q3.
| dy
| Sets the y coordinate step for multi-box traces set
| using q1/median/q3.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.box.Hoverlabel` instance
| or dict with compatible properties
| hoveron
| Do the hover effects highlight individual boxes or
| sample points or both?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the box(es).
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.box.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.box.Line` instance or dict
| with compatible properties
| lowerfence
| Sets the lower fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `lowerfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the lower as the last sample
| point below 1.5 times the IQR.
| lowerfencesrc
| Sets the source reference on Chart Studio Cloud for
| `lowerfence`.
| marker
| :class:`plotly.graph_objects.box.Marker` instance or
| dict with compatible properties
| mean
| Sets the mean values. There should be as many items as
| the number of boxes desired. This attribute has effect
| only under the q1/median/q3 signature. If `mean` is not
| provided but a sample (in `y` or `x`) is set, we
| compute the mean for each box using the sample values.
| meansrc
| Sets the source reference on Chart Studio Cloud for
| `mean`.
| median
| Sets the median values. There should be as many items
| as the number of boxes desired.
| mediansrc
| Sets the source reference on Chart Studio Cloud for
| `median`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For box traces, the name will
| also be used for the position coordinate, if `x` and
| `x0` (`y` and `y0` if horizontal) are missing and the
| position axis is categorical
| notched
| Determines whether or not notches are drawn. Notches
| displays a confidence interval around the median. We
| compute the confidence interval as median +/- 1.57 *
| IQR / sqrt(N), where IQR is the interquartile range and
| N is the sample size. If two boxes' notches do not
| overlap there is 95% confidence their medians differ.
| See https://sites.google.com/site/davidsstatistics/home
| /notched-box-plots for more info. Defaults to False
| unless `notchwidth` or `notchspan` is set.
| notchspan
| Sets the notch span from the boxes' `median` values.
| There should be as many items as the number of boxes
| desired. This attribute has effect only under the
| q1/median/q3 signature. If `notchspan` is not provided
| but a sample (in `y` or `x`) is set, we compute it as
| 1.57 * IQR / sqrt(N), where N is the sample size.
| notchspansrc
| Sets the source reference on Chart Studio Cloud for
| `notchspan`.
| notchwidth
| Sets the width of the notches relative to the box'
| width. For example, with 0, the notches are as wide as
| the box(es).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the box(es). If "v" ("h"), the
| distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the box(es). If 0, the sample points are places over
| the center of the box(es). Positive (negative) values
| correspond to positions to the right (left) for
| vertical boxes and above (below) for horizontal boxes
| q1
| Sets the Quartile 1 values. There should be as many
| items as the number of boxes desired.
| q1src
| Sets the source reference on Chart Studio Cloud for
| `q1`.
| q3
| Sets the Quartile 3 values. There should be as many
| items as the number of boxes desired.
| q3src
| Sets the source reference on Chart Studio Cloud for
| `q3`.
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| sd
| Sets the standard deviation values. There should be as
| many items as the number of boxes desired. This
| attribute has effect only under the q1/median/q3
| signature. If `sd` is not provided but a sample (in `y`
| or `x`) is set, we compute the standard deviation for
| each box using the sample values.
| sdmultiple
| Scales the box size when sizemode=sd Allowing boxes to
| be drawn across any stddev range For example 1-stddev,
| 3-stddev, 5-stddev
| sdsrc
| Sets the source reference on Chart Studio Cloud for
| `sd`.
| selected
| :class:`plotly.graph_objects.box.Selected` instance or
| dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showwhiskers
| Determines whether or not whiskers are visible.
| Defaults to true for `sizemode` "quartiles", false for
| "sd".
| sizemode
| Sets the upper and lower bound for the boxes quartiles
| means box is drawn between Q1 and Q3 SD means the box
| is drawn between Mean +- Standard Deviation Argument
| sdmultiple (default 1) to scale the box size So it
| could be drawn 1-stddev, 3-stddev etc
| stream
| :class:`plotly.graph_objects.box.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.box.Unselected` instance
| or dict with compatible properties
| upperfence
| Sets the upper fence values. There should be as many
| items as the number of boxes desired. This attribute
| has effect only under the q1/median/q3 signature. If
| `upperfence` is not provided but a sample (in `y` or
| `x`) is set, we compute the upper as the last sample
| point above 1.5 times the IQR.
| upperfencesrc
| Sets the source reference on Chart Studio Cloud for
| `upperfence`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| width
| Sets the width of the box in data coordinate If 0
| (default value) the width is automatically selected
| based on the positions of other box traces in the same
| subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_candlestick(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, whiskerwidth=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Candlestick trace
|
| The candlestick is a style of financial chart describing open,
| high, low and close for a given `x` coordinate (most likely
| time). The boxes represent the spread between the `open` and
| `close` values and the lines represent the spread between the
| `low` and `high` values Sample points where the close value is
| higher (lower) then the open value are called increasing
| (decreasing). By default, increasing candles are drawn in green
| whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.candlestick.Decreasing`
| instance or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.candlestick.Hoverlabel`
| instance or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.candlestick.Increasing`
| instance or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.candlestick.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.candlestick.Line` instance
| or dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.candlestick.Stream`
| instance or dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| whiskerwidth
| Sets the width of the whiskers relative to the box'
| width. For example, with 1, the whiskers are as wide as
| the box(es).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| 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, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xsrc=None, y=None, yaxis=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Carpet trace
|
| The data describing carpet axis layout is set in `y` and
| (optionally) also `x`. If only `y` is present, `x` the plot is
| interpreted as a cheater plot and is filled in using the `y`
| values. `x` and `y` may either be 2D arrays matching with each
| dimension matching that of `a` and `b`, or they may be 1D
| arrays with total length equal to that of `a` and `b`.
|
| Parameters
| ----------
| a
| An array containing values of the first parameter value
| a0
| Alternate to `a`. Builds a linear space of a
| coordinates. Use with `da` where `a0` is the starting
| coordinate and `da` the step.
| aaxis
| :class:`plotly.graph_objects.carpet.Aaxis` instance or
| dict with compatible properties
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| A two dimensional array of y coordinates at each carpet
| point.
| b0
| Alternate to `b`. Builds a linear space of a
| coordinates. Use with `db` where `b0` is the starting
| coordinate and `db` the step.
| baxis
| :class:`plotly.graph_objects.carpet.Baxis` instance or
| dict with compatible properties
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| cheaterslope
| The shift applied to each successive row of data in
| creating a cheater plot. Only used if `x` is been
| omitted.
| color
| Sets default for all colors associated with this axis
| all at once: line, font, tick, and grid colors. Grid
| color is lightened by blending this with the plot
| background Individual pieces can override this.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the a coordinate step. See `a0` for more info.
| db
| Sets the b coordinate step. See `b0` for more info.
| font
| The default font used for axis & tick labels on this
| carpet
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.carpet.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| stream
| :class:`plotly.graph_objects.carpet.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| A two dimensional array of x coordinates at each carpet
| point. If omitted, the plot is a cheater plot and the
| xaxis is hidden by default.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| A two dimensional array of y coordinates at each carpet
| point.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_choropleth(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Choropleth trace
|
| The data that describes the choropleth value-to-color mapping
| is set in `z`. The geographic locations corresponding to each
| value in `z` are set in `locations`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choropleth.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choropleth.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choropleth.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names. See
| `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choropleth.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choropleth.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choropleth.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choropleth.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_choroplethmap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Choroplethmap trace
|
| GeoJSON features to be filled are set in `geojson` The data
| that describes the choropleth value-to-color mapping is set in
| `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmap traces are placed above the water layers.
| If set to '', the layer will be inserted above every
| existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmap.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_choroplethmapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Choroplethmapbox trace
|
| "choroplethmapbox" trace is deprecated! Please consider
| switching to the "choroplethmap" trace type and `map` subplots.
| Learn more at: https://plotly.com/javascript/maplibre-
| migration/ GeoJSON features to be filled are set in `geojson`
| The data that describes the choropleth value-to-color mapping
| is set in `locations` and `z`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the choropleth polygons will be inserted
| before the layer with the specified ID. By default,
| choroplethmapbox traces are placed above the water
| layers. If set to '', the layer will be inserted above
| every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array.
| Support nested property, for example "properties.name".
| geojson
| Sets the GeoJSON data associated with this trace. It
| can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of
| type "Polygon" or "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
| l` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `properties` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.choroplethmapbox.Legendgro
| uptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| locations
| Sets which features found in "geojson" to plot using
| their feature `id` field.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| marker
| :class:`plotly.graph_objects.choroplethmapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| selected
| :class:`plotly.graph_objects.choroplethmapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.choroplethmapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets the text elements associated with each location.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.choroplethmapbox.Unselecte
| d` instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the color values.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_cone(self, anchor=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizemode=None, sizeref=None, stream=None, text=None, textsrc=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Cone trace
|
| Use cone traces to visualize vector fields. Specify a vector
| field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and
| 3 vector component arrays `u`, `v`, `w`. The cones are drawn
| exactly at the positions given by `x`, `y` and `z`.
|
| Parameters
| ----------
| anchor
| Sets the cones' anchor with respect to their x/y/z
| positions. Note that "cm" denote the cone's center of
| mass which corresponds to 1/4 from the tail to tip.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.cone.ColorBar` instance or
| dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.cone.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `norm` Anything contained in tag `<extra>`
| is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.cone.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.cone.Lighting` instance or
| dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.cone.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizemode
| Determines whether `sizeref` is set as a "scaled" (i.e
| unitless) scalar (normalized by the max u/v/w norm in
| the vector field) or as "absolute" value (in the same
| units as the vector field). To display sizes in actual
| vector length use "raw".
| sizeref
| Adjusts the cone size scaling. The size of the cones is
| determined by their u/v/w norm multiplied a factor and
| `sizeref`. This factor (computed internally)
| corresponds to the minimum "time" to travel across two
| successive x/y/z positions at the average velocity of
| those two successive positions. All cones in a given
| trace use the same factor. With `sizemode` set to
| "raw", its default value is 1. With `sizemode` set to
| "scaled", `sizeref` is unitless, its default value is
| 0.5. With `sizemode` set to "absolute", `sizeref` has
| the same units as the u/v/w vector field, its the
| default value is half the sample's maximum vector norm.
| stream
| :class:`plotly.graph_objects.cone.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the cones. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field and of the
| displayed cones.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field and of the
| displayed cones.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field and of the
| displayed cones.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_contour(self, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Contour trace
|
| The data from which contour lines are computed is set in `z`.
| Data in `z` must be a 2D list of numbers. Say that `z` has N
| rows and M columns, then by default, these N rows correspond to
| N y coordinates (set in `y` or auto-generated) and the M
| columns correspond to M x coordinates (set in `x` or auto-
| generated). By setting `transpose` to True, the above behavior
| is flipped.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contour.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array otherwise it
| is defaulted to false.
| contours
| :class:`plotly.graph_objects.contour.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.contour.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contour.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contour.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contour.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| 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, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Contourcarpet trace
|
| Plots contours on either the first carpet axis or the carpet
| axis with a matching `carpet` attribute. Data `z` is
| interpreted as matching that of the corresponding carpet axis.
|
| Parameters
| ----------
| a
| Sets the x coordinates.
| a0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| atype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| b
| Sets the y coordinates.
| b0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| btype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| carpet
| The `carpet` of the carpet axes on which this contour
| trace lies
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.contourcarpet.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.contourcarpet.Contours`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| da
| Sets the x coordinate step. See `x0` for more info.
| db
| Sets the y coordinate step. See `y0` for more info.
| fillcolor
| Sets the fill color if `contours.type` is "constraint".
| Defaults to a half-transparent variant of the line
| color, marker color, or marker line color, whichever is
| available.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.contourcarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.contourcarpet.Line`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.contourcarpet.Stream`
| instance or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_densitymap(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Densitymap trace
|
| Draws a bivariate kernel density estimation with a Gaussian
| kernel from `lon` and `lat` coordinates and optional `z` values
| using a colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymap trace will be inserted
| before the layer with the specified ID. By default,
| densitymap traces are placed below the first layer of
| type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymap.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymap
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_densitymapbox(self, autocolorscale=None, below=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lon=None, lonsrc=None, meta=None, metasrc=None, name=None, opacity=None, radius=None, radiussrc=None, reversescale=None, showlegend=None, showscale=None, stream=None, subplot=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Densitymapbox trace
|
| "densitymapbox" trace is deprecated! Please consider switching
| to the "densitymap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ Draws a
| bivariate kernel density estimation with a Gaussian kernel from
| `lon` and `lat` coordinates and optional `z` values using a
| colorscale.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| below
| Determines if the densitymapbox trace will be inserted
| before the layer with the specified ID. By default,
| densitymapbox traces are placed below the first layer
| of type symbol If set to '', the layer will be inserted
| above every existing layer.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.densitymapbox.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.densitymapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.densitymapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| radius
| Sets the radius of influence of one `lon` / `lat` point
| in pixels. Increasing the value makes the densitymapbox
| trace smoother, but less detailed.
| radiussrc
| Sets the source reference on Chart Studio Cloud for
| `radius`.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.densitymapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| z
| Sets the points' weight. For example, a value of 10
| would be equivalent to having 10 points of weight 1 in
| the same spot
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_funnel(self, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Funnel trace
|
| Visualize stages in a process using length-encoded bars. This
| trace can be used to show data in either a part-to-whole
| representation wherein each item appears in a single stage, or
| in a "drop-off" representation wherein each item appears in
| each stage it traversed. See also the "funnelarea" trace type
| for a different approach to visualizing funnel data.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.funnel.Connector` instance
| or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnel.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious` and
| `percentTotal`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnel.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnel.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the funnels. With "v" ("h"),
| the value of the each bar spans along the vertical
| (horizontal). By default funnels are tend to be
| oriented horizontally; unless only "y" array is
| presented or orientation is set to "v". Also regarding
| graphs including only 'horizontal' funnels, "autorange"
| on the "y-axis" are set to "reversed".
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnel.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple funnels, percentages &
| totals are computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious`,
| `percentTotal`, `label` and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_funnelarea(self, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Funnelarea trace
|
| Visualize stages in a process using area-encoded trapezoids.
| This trace can be used to show data in a part-to-whole
| representation similar to a "pie" trace, wherein each item
| appears in a single stage. See also the "funnel" trace type for
| a different approach to visualizing funnel data.
|
| Parameters
| ----------
| aspectratio
| Sets the ratio between height and width
| baseratio
| Sets the ratio between bottom length and maximum top
| length.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.funnelarea.Domain`
| instance or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnelarea.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnelarea.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnelarea.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnelarea.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.funnelarea.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_heatmap(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Heatmap trace
|
| The data that describes the heatmap value-to-color mapping is
| set in `z`. Data in `z` can either be a 2D list of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a 2D list, say that `z` has N rows and M columns. Then, by
| default, the resulting heatmap will have N partitions along the
| y axis and M partitions along the x axis. In other words, the
| i-th row/ j-th column cell in `z` is mapped to the i-th
| partition of the y axis (starting from the bottom of the plot)
| and the j-th partition of the x-axis (starting from the left of
| the plot). This behavior can be flipped by using `transpose`.
| Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1)
| elements. If M (N), then the coordinates correspond to the
| center of the heatmap cells and the cells have equal width. If
| M+1 (N+1), then the coordinates correspond to the edges of the
| heatmap cells. In the case where `z` is a 1D list, the x and y
| coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmap.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array and `zsmooth`
| is not false; otherwise it is defaulted to false.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmap.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmap.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_heatmapgl(self, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Heatmapgl trace
|
| "heatmapgl" trace is deprecated! Please consider switching to
| the "heatmap" or "image" trace types. Alternatively you could
| contribute/sponsor rewriting this trace type based on cartesian
| features and using regl framework. WebGL version of the heatmap
| trace type.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmapgl.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmapgl.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmapgl.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_histogram(self, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Histogram trace
|
| The sample data from which statistics are computed is set in
| `x` for vertically spanning histograms and in `y` for
| horizontally spanning histograms. Binning options are set
| `xbins` and `ybins` respectively if no aggregation data is
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| bingroup
| Set a group of histogram traces which will have
| compatible bin settings. Note that traces on the same
| subplot and with the same "orientation" under `barmode`
| "stack", "relative" and "group" are forced into the
| same bingroup, Using `bingroup`, traces under `barmode`
| "overlay" and on different axes (of the same axis type)
| can have compatible bin settings. Note that histogram
| and histogram2d* trace can share the same `bingroup`
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| cumulative
| :class:`plotly.graph_objects.histogram.Cumulative`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.histogram.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.histogram.ErrorY` instance
| or dict with compatible properties
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `binNumber` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.histogram.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.histogram.Stream` instance
| or dict with compatible properties
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the text font.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label` and `value`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.histogram.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbins
| :class:`plotly.graph_objects.histogram.XBins` instance
| or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybins
| :class:`plotly.graph_objects.histogram.YBins` instance
| or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_histogram2d(self, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Histogram2d trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a heatmap.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2d.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2d.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram2d.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2d.Stream`
| instance or dict with compatible properties
| textfont
| Sets the text font.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z`
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2d.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2d.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_histogram2dcontour(self, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Histogram2dContour trace
|
| The sample data from which statistics are computed is set in
| `x` and `y` (where `x` and `y` represent marginal
| distributions, binning is set in `xbins` and `ybins` in this
| case) or `z` (where `z` represent the 2D distribution and
| binning set, binning is set by `x` and `y` in this case). The
| resulting distribution is visualized as a contour plot.
|
| Parameters
| ----------
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2dcontour.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.histogram2dcontour.Contour
| s` instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2dcontour.Hoverla
| bel` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2dcontour.Legendg
| rouptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.histogram2dcontour.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.histogram2dcontour.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2dcontour.Stream`
| instance or dict with compatible properties
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2dcontour.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2dcontour.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_hline(self, y, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a horizontal line to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y: float or int
| A number representing the y coordinate of the horizontal line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_hrect(self, y0, y1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a rectangle to a plot or subplot that extends infinitely in the
| x-dimension.
|
| Parameters
| ----------
| y0: float or int
| A number representing the y coordinate of one side of the rectangle.
| y1: float or int
| A number representing the y coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_icicle(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Icicle trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The icicle sectors are determined
| by the entries in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.icicle.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.icicle.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.icicle.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.icicle.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.icicle.Marker` instance or
| dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.icicle.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.icicle.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.icicle.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.icicle.Tiling` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_image(self, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Image trace
|
| Display an image, i.e. data on a 2D regular raster. By default,
| when an image is displayed in a subplot, its y axis will be
| reversed (ie. `autorange: 'reversed'`), constrained to the
| domain (ie. `constrain: 'domain'`) and it will have the same
| scale as its x axis (ie. `scaleanchor: 'x,`) in order for
| pixels to be rendered as squares.
|
| Parameters
| ----------
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified,
| this attribute will be set to `rgba256` otherwise it
| defaults to `rgb`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Set the pixel's horizontal size.
| dy
| Set the pixel's vertical size
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.image.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `z`, `color` and `colormodel`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.image.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| source
| Specifies the data URI of the image to be visualized.
| The URI consists of "data:image/[<media
| subtype>][;base64],<data>"
| stream
| :class:`plotly.graph_objects.image.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Set the image's x position. The left edge of the image
| (or the right edge if the x axis is reversed or dx is
| negative) will be found at xmin=x0-dx/2
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| y0
| Set the image's y position. The top edge of the image
| (or the bottom edge if the y axis is NOT reversed or if
| dy is negative) will be found at ymin=y0-dy/2. By
| default when an image trace is included, the y axis
| will be reversed so that the image is right-side-up,
| but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis
| range.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| A 2-dimensional array in which each element is an array
| of 3 or 4 numbers representing a color.
| zmax
| Array defining the higher bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [255,
| 255, 255]. For the `rgba` colormodel, it is [255, 255,
| 255, 1]. For the `rgba256` colormodel, it is [255, 255,
| 255, 255]. For the `hsl` colormodel, it is [360, 100,
| 100]. For the `hsla` colormodel, it is [360, 100, 100,
| 1].
| zmin
| Array defining the lower bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [0, 0,
| 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For
| the `rgba256` colormodel, it is [0, 0, 0, 0]. For the
| `hsl` colormodel, it is [0, 0, 0]. For the `hsla`
| colormodel, it is [0, 0, 0, 0].
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data.
| This only applies for image traces that use the
| `source` attribute.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_indicator(self, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Indicator trace
|
| An indicator is used to visualize a single `value` along with
| some contextual information such as `steps` or a `threshold`,
| using a combination of three visual elements: a number, a
| delta, and/or a gauge. Deltas are taken with respect to a
| `reference`. Gauges can be either angular or bullet (aka
| linear) gauges.
|
| Parameters
| ----------
| align
| Sets the horizontal alignment of the `text` within the
| box. Note that this attribute has no effect if an
| angular gauge is displayed: in this case, it is always
| centered
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delta
| :class:`plotly.graph_objects.indicator.Delta` instance
| or dict with compatible properties
| domain
| :class:`plotly.graph_objects.indicator.Domain` instance
| or dict with compatible properties
| gauge
| The gauge of the Indicator plot.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.indicator.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines how the value is displayed on the graph.
| `number` displays the value numerically in text.
| `delta` displays the difference to a reference value in
| text. Finally, `gauge` displays the value graphically
| on an axis.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| number
| :class:`plotly.graph_objects.indicator.Number` instance
| or dict with compatible properties
| stream
| :class:`plotly.graph_objects.indicator.Stream` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.indicator.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the number to be displayed.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_isosurface(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Isosurface trace
|
| Draws isosurfaces between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.isosurface.Caps` instance
| or dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.isosurface.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.isosurface.Contour`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.isosurface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.isosurface.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.isosurface.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.isosurface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.isosurface.Slices`
| instance or dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.isosurface.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.isosurface.Stream`
| instance or dict with compatible properties
| surface
| :class:`plotly.graph_objects.isosurface.Surface`
| instance or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_layout_image(self, arg=None, layer=None, name=None, opacity=None, sizex=None, sizey=None, sizing=None, source=None, templateitemname=None, visible=None, x=None, xanchor=None, xref=None, y=None, yanchor=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new image to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Image or dict with compatible properties
| layer
| Specifies whether images are drawn below or above
| traces. When `xref` and `yref` are both set to `paper`,
| image is drawn below the entire plot area.
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the image.
| sizex
| Sets the image container size horizontally. The image
| will be sized based on the `position` value. When
| `xref` is set to `paper`, units are sized relative to
| the plot width. When `xref` ends with ` domain`, units
| are sized relative to the axis width.
| sizey
| Sets the image container size vertically. The image
| will be sized based on the `position` value. When
| `yref` is set to `paper`, units are sized relative to
| the plot height. When `yref` ends with ` domain`, units
| are sized relative to the axis height.
| sizing
| Specifies which dimension of the image to constrain.
| source
| Specifies the URL of the image to be used. The URL must
| be accessible from the domain where the plot code is
| run, and can be either relative or absolute.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| visible
| Determines whether or not this image is visible.
| x
| Sets the image's x position. When `xref` is set to
| `paper`, units are sized relative to the plot height.
| See `xref` for more info
| xanchor
| Sets the anchor for the x position
| xref
| Sets the images's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y
| Sets the image's y position. When `yref` is set to
| `paper`, units are sized relative to the plot height.
| See `yref` for more info
| yanchor
| Sets the anchor for the y position.
| yref
| Sets the images's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for image. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for image. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add image to secondary y-axis
| exclude_empty_subplots
| If True, image will not be added to subplots without
| traces.
|
| Returns
| -------
| FigureWidget
|
| add_mesh3d(self, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Mesh3d trace
|
| Draws sets of triangles with coordinates given by three
| 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`,
| `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-
| shape algorithm or (4) the Convex-hull algorithm
|
| Parameters
| ----------
| alphahull
| Determines how the mesh surface triangles are derived
| from the set of vertices (points) represented by the
| `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays
| are not supplied. For general use of `mesh3d` it is
| preferred that `i`, `j`, `k` are supplied. If "-1",
| Delaunay triangulation is used, which is mainly
| suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In
| case the `delaunayaxis` intersects the mesh surface at
| more than one point it will result triangles that are
| very long in the dimension of `delaunayaxis`. If ">0",
| the alpha-shape algorithm is used. In this case, the
| positive `alphahull` value signals the use of the
| alpha-shape algorithm, _and_ its value acts as the
| parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or
| if the intention is to enclose the `x`, `y` and `z`
| point set into a convex hull.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `intensity`) or
| the bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `intensity`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmax`
| must be set as well.
| color
| Sets the color of the whole mesh
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.mesh3d.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.mesh3d.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is
| perpendicular to the surface of the Delaunay
| triangulation. It has an effect if `i`, `j`, `k` are
| not provided and `alphahull` is set to indicate
| Delaunay triangulation.
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.mesh3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| i
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "first" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `i[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `i` represents a point in space, which
| is the first vertex of a triangle.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| intensity
| Sets the intensity values for vertices or cells as
| defined by `intensitymode`. It can be used for plotting
| fields on meshes.
| intensitymode
| Determines the source of `intensity` values.
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
| isrc
| Sets the source reference on Chart Studio Cloud for
| `i`.
| j
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "second" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `j[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `j` represents a point in space, which
| is the second vertex of a triangle.
| jsrc
| Sets the source reference on Chart Studio Cloud for
| `j`.
| k
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "third" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `k[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `k` represents a point in space, which
| is the third vertex of a triangle.
| ksrc
| Sets the source reference on Chart Studio Cloud for
| `k`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.mesh3d.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.mesh3d.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.mesh3d.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.mesh3d.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| vertexcolor
| Sets the color of each vertex Overrides "color". While
| Red, green and blue colors are in the range of 0 and
| 255; in the case of having vertex color data in RGBA
| format, the alpha color should be normalized to be
| between 0 and 1.
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_ohlc(self, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Ohlc trace
|
| The ohlc (short for Open-High-Low-Close) is a style of
| financial chart describing open, high, low and close for a
| given `x` coordinate (most likely time). The tip of the lines
| represent the `low` and `high` values and the horizontal
| segments represent the `open` and `close` values. Sample points
| where the close value is higher (lower) then the open value are
| called increasing (decreasing). By default, increasing items
| are drawn in green whereas decreasing are drawn in red.
|
| Parameters
| ----------
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.ohlc.Decreasing` instance
| or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.ohlc.Hoverlabel` instance
| or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.ohlc.Increasing` instance
| or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.ohlc.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.ohlc.Line` instance or
| dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.ohlc.Stream` instance or
| dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| tickwidth
| Sets the width of the open/close tick marks relative to
| the "x" minimal interval.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_parcats(self, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Parcats trace
|
| Parallel categories diagram for multidimensional categorical
| data.
|
| Parameters
| ----------
| arrangement
| Sets the drag interaction mode for categories and
| dimensions. If `perpendicular`, the categories can only
| move along a line perpendicular to the paths. If
| `freeform`, the categories can freely move on the
| plane. If `fixed`, the categories and dimensions are
| stationary.
| bundlecolors
| Sort paths so that like colors are bundled together
| within each category.
| counts
| The number of observations represented by each state.
| Defaults to 1 so that each state represents one
| observation
| countssrc
| Sets the source reference on Chart Studio Cloud for
| `counts`.
| dimensions
| The dimensions (variables) of the parallel categories
| diagram.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets
| the default property values to use for elements of
| parcats.dimensions
| domain
| :class:`plotly.graph_objects.parcats.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoveron
| Sets the hover interaction mode for the parcats
| diagram. If `category`, hover interaction take place
| per category. If `color`, hover interactions take place
| per color per category. If `dimension`, hover
| interactions take place across all categories per
| dimension.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. This value here applies when hovering
| over dimensions. Note that `*categorycount`,
| "colorcount" and "bandcolorcount" are only available
| when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`,
| `probability`, `category`, `categorycount`,
| `colorcount` and `bandcolorcount`. Anything contained
| in tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| labelfont
| Sets the font for the `dimension` labels.
| legendgrouptitle
| :class:`plotly.graph_objects.parcats.Legendgrouptitle`
| instance or dict with compatible properties
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcats.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort
| paths based on dimension categories from left to right.
| If `backward`, sort paths based on dimensions
| categories from right to left.
| stream
| :class:`plotly.graph_objects.parcats.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `category` labels.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_parcoords(self, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Parcoords trace
|
| Parallel coordinates for multidimensional exploratory data
| analysis. The samples are specified in `dimensions`. The colors
| are set in `line.color`.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets
| the default property values to use for elements of
| parcoords.dimensions
| domain
| :class:`plotly.graph_objects.parcoords.Domain` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| labelangle
| Sets the angle of the labels with respect to the
| horizontal. For example, a `tickangle` of -90 draws the
| labels vertically. Tilted labels with "labelangle" may
| be positioned better inside margins when
| `labelposition` is set to "bottom".
| labelfont
| Sets the font for the `dimension` labels.
| labelside
| Specifies the location of the `label`. "top" positions
| labels above, next to the title "bottom" positions
| labels below the graph Tilted labels with "labelangle"
| may be positioned better inside margins when
| `labelposition` is set to "bottom".
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.parcoords.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcoords.Line` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| rangefont
| Sets the font for the `dimension` range values.
| stream
| :class:`plotly.graph_objects.parcoords.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.parcoords.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_pie(self, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Pie trace
|
| A data visualized by the sectors of the pie is set in `values`.
| The sector labels are set in `labels`. The sector colors are
| set in `marker.colors`
|
| Parameters
| ----------
| automargin
| Determines whether outside text labels can push the
| margins.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| direction
| Specifies the direction at which succeeding sectors
| follow one another.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.pie.Domain` instance or
| dict with compatible properties
| hole
| Sets the fraction of the radius to cut out of the pie.
| Use this to make a donut chart.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pie.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pie.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pie.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector.
| pull
| Sets the fraction of larger radius to pull the sectors
| out from the center. This can be a constant to pull all
| slices apart from each other equally or an array to
| highlight one or more slices.
| pullsrc
| Sets the source reference on Chart Studio Cloud for
| `pull`.
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pie charts that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.pie.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.pie.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the
| font used for `title`. Note that the title's font used
| to be set by the now deprecated `titlefont` attribute.
| titleposition
| Deprecated: Please use pie.title.position instead.
| Specifies the location of the `title`. Note that the
| title's position used to be set by the now deprecated
| `titleposition` attribute.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_pointcloud(self, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Pointcloud trace
|
| "pointcloud" trace is deprecated! Please consider switching to
| the "scattergl" trace type. The data visualized as a point
| cloud set in `x` and `y` using the WebGl plotting engine.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pointcloud.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| indices
| A sequential value, 0..n, supply it to avoid creating
| this array inside plotting. If specified, it must be a
| typed `Int32Array` array. Its length must be equal to
| or greater than the number of points. For the best
| performance and memory use, create one large `indices`
| typed array that is guaranteed to be at least as long
| as the largest number of points during use, and reuse
| it on each `Plotly.restyle()` call.
| indicessrc
| Sets the source reference on Chart Studio Cloud for
| `indices`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pointcloud.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pointcloud.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.pointcloud.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `ybounds` for the performance
| benefits.
| xboundssrc
| Sets the source reference on Chart Studio Cloud for
| `xbounds`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xy
| Faster alternative to specifying `x` and `y`
| separately. If supplied, it must be a typed
| `Float32Array` array that represents points such that
| `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`
| xysrc
| Sets the source reference on Chart Studio Cloud for
| `xy`.
| y
| Sets the y coordinates.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `xbounds` for the performance
| benefits.
| yboundssrc
| Sets the source reference on Chart Studio Cloud for
| `ybounds`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_sankey(self, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Sankey trace
|
| Sankey plots for network flow data analysis. The nodes are
| specified in `nodes` and the links between sources and targets
| in `links`. The colors are set in `nodes[i].color` and
| `links[i].color`, otherwise defaults are used.
|
| Parameters
| ----------
| arrangement
| If value is `snap` (the default), the node arrangement
| is assisted by automatic snapping of elements to
| preserve space between nodes specified via `nodepad`.
| If value is `perpendicular`, the nodes can only move
| along a line perpendicular to the flow. If value is
| `freeform`, the nodes can freely move on the plane. If
| value is `fixed`, the nodes are stationary.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sankey.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired. Note that this attribute is
| superseded by `node.hoverinfo` and `node.hoverinfo` for
| nodes and links respectively.
| hoverlabel
| :class:`plotly.graph_objects.sankey.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sankey.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| link
| The links of the Sankey plot.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| orientation
| Sets the orientation of the Sankey diagram.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| stream
| :class:`plotly.graph_objects.sankey.Stream` instance or
| dict with compatible properties
| textfont
| Sets the font for node labels
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| valuesuffix
| Adds a unit to follow the value in the hover tooltip.
| Add a space if a separation is necessary from the
| value.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scatter(self, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Scatter trace
|
| The scatter trace type encompasses line charts, scatter charts,
| text charts, and bubble charts. The data visualized as scatter
| point or lines is set in `x` and `y`. Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scatter.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available. If fillgradient is
| specified, fillcolor is ignored except for setting the
| background color of the hover label, if any.
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor
| is used instead.
| fillpattern
| Sets the pattern within the marker.
| groupnorm
| Only relevant when `stackgroup` is used, and only the
| first `groupnorm` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Sets the normalization for the sum of
| this `stackgroup`. With "fraction", the value of each
| trace at each location is divided by the sum of all
| trace values at that location. "percent" is the same
| but multiplied by 100 to show percentages. If there are
| multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Only relevant in the following cases: 1. when
| `scattermode` is set to "group". 2. when `stackgroup`
| is used, and only the first `orientation` found in the
| `stackgroup` will be used - including if `visible` is
| "legendonly" but not if it is `false`. Sets the
| stacking direction. With "v" ("h"), the y (x) values of
| subsequent traces are added. Also affects the default
| value of `fill`.
| selected
| :class:`plotly.graph_objects.scatter.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stackgaps
| Only relevant when `stackgroup` is used, and only the
| first `stackgaps` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Determines how we handle locations at
| which other traces in this group have data but this one
| does not. With *infer zero* we insert a zero at these
| locations. With "interpolate" we linearly interpolate
| between existing values, and extrapolate a constant
| beyond the existing values.
| stackgroup
| Set several scatter traces (on the same subplot) to the
| same stackgroup in order to add their y values (or
| their x values if `orientation` is "h"). If blank or
| omitted this trace will not be stacked. Stacking also
| turns `fill` on by default, using "tonexty" ("tonextx")
| if `orientation` is "h" ("v") and sets the default
| `mode` to "lines" irrespective of point count. You can
| only stack on a numeric (linear or log) axis. Traces in
| a `stackgroup` will only fill to (or be filled to)
| other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if
| fill-linked traces are not already consecutive, the
| later ones will be pushed down in the drawing order.
| stream
| :class:`plotly.graph_objects.scatter.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatter.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_scatter3d(self, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatter3d trace
|
| The data visualized as scatter point or lines in 3D dimension
| is set in `x`, `y`, `z`. Text (appearing either on the chart or
| on hover only) is via `text`. Bubble charts are achieved by
| setting `marker.size` and/or `marker.color` Projections are
| achieved via `projection`. Surface fills are achieved via
| `surfaceaxis`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.scatter3d.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter3d.ErrorY` instance
| or dict with compatible properties
| error_z
| :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter3d.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter3d.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| projection
| :class:`plotly.graph_objects.scatter3d.Projection`
| instance or dict with compatible properties
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatter3d.Stream` instance
| or dict with compatible properties
| surfaceaxis
| If "-1", the scatter points are not fill with a surface
| If 0, 1, 2, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Scattercarpet trace
|
| Plots a scatter trace on either the first carpet axis or the
| carpet axis with a matching `carpet` attribute.
|
| Parameters
| ----------
| a
| Sets the a-axis coordinates.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the b-axis coordinates.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattercarpet.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b). To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattercarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattercarpet.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattercarpet.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattercarpet.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattercarpet.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (a,b) point. If
| a single string, the same string appears over all the
| data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattercarpet.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_scattergeo(self, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattergeo trace
|
| The data visualized as scatter point or lines on a geographic
| map is provided either by longitude/latitude pairs in `lon` and
| `lat` respectively or by geographic location IDs or names in
| `locations`.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used
| when `locations` is set. It can be set as a valid
| GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or
| "Feature" with geometries of type "Polygon" or
| "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergeo.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair or item in `locations`. If a single string, the
| same string appears over all the data points. If an
| array of string, the items are mapped in order to the
| this trace's (lon,lat) or `locations` coordinates. To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergeo.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergeo.Line` instance
| or dict with compatible properties
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names.
| Coordinates correspond to the centroid of each location
| given. See `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattergeo.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergeo.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergeo.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (lon,lat) pair
| or item in `locations`. If a single string, the same
| string appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (lon,lat) or `locations` coordinates. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is
| not set, these elements will be seen in the hover
| labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon`, `location` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergeo.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Scattergl trace
|
| The data visualized as scatter point or lines is set in `x` and
| `y` using the WebGL plotting engine. Bubble charts are achieved
| by setting `marker.size` and/or `marker.color` to a numerical
| arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scattergl.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scattergl.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergl.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattergl.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergl.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_scattermap(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattermap trace
|
| The data visualized as scatter point, lines or marker symbols
| on a MapLibre GL geographic map is provided by
| longitude/latitude pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermap trace's layers are to be
| inserted before the layer with the specified ID. By
| default, scattermap layers are inserted above all the
| base layers. To place the scattermap layers above every
| other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermap.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermap.Line` instance
| or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=map.layer.paint.text-
| color, size=map.layer.layout.text-size). Has an effect
| only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scattermapbox(self, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattermapbox trace
|
| "scattermapbox" trace is deprecated! Please consider switching
| to the "scattermap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ The data
| visualized as scatter point, lines or marker symbols on a
| Mapbox GL geographic map is provided by longitude/latitude
| pairs in `lon` and `lat`.
|
| Parameters
| ----------
| below
| Determines if this scattermapbox trace's layers are to
| be inserted before the layer with the specified ID. By
| default, scattermapbox layers are inserted above all
| the base layers. To place the scattermapbox layers
| above every other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermapbox.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermapbox.Line`
| instance or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-
| color, size=mapbox.layer.layout.text-size). Has an
| effect only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermapbox.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scatterpolar(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatterpolar trace
|
| The scatterpolar trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in polar coordinates.
| The data visualized as scatter point or lines is set in `r`
| (radial) and `theta` (angular) coordinates Text (appearing
| either on the chart or on hover only) is via `text`. Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterpolar has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolar.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolar.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolar.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolar.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolar.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scatterpolargl(self, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatterpolargl trace
|
| The scatterpolargl trace type encompasses line charts, scatter
| charts, and bubble charts in polar coordinates using the WebGL
| plotting engine. The data visualized as scatter point or lines
| is set in `r` (radial) and `theta` (angular) coordinates Bubble
| charts are achieved by setting `marker.size` and/or
| `marker.color` to numerical arrays.
|
| Parameters
| ----------
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolargl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolargl.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolargl.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolargl.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolargl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolargl.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolargl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_scattersmith(self, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scattersmith trace
|
| The scattersmith trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in smith coordinates.
| The data visualized as scatter point or lines is set in `real`
| and `imag` (imaginary) coordinates Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scattersmith has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattersmith.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| imagsrc
| Sets the source reference on Chart Studio Cloud for
| `imag`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattersmith.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattersmith.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattersmith.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| real
| Sets the real component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| realsrc
| Sets the source reference on Chart Studio Cloud for
| `real`.
| selected
| :class:`plotly.graph_objects.scattersmith.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattersmith.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a smith subplot. If "smith" (the default value),
| the data refer to `layout.smith`. If "smith2", the data
| refer to `layout.smith2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `real`, `imag` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattersmith.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Scatterternary trace
|
| Provides similar functionality to the "scatter" type but on a
| ternary phase diagram. The data is provided by at least two
| arrays out of `a`, `b`, `c` triplets.
|
| Parameters
| ----------
| a
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on Chart Studio Cloud for
| `c`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterternary.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b,c)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b,c).
| To be seen, trace `hoverinfo` must contain a "text"
| flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterternary.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterternary.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterternary.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scatterternary.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterternary.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If "ternary" (the default
| value), the data refer to `layout.ternary`. If
| "ternary2", the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b`, `c` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterternary.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_selection(self, arg=None, line=None, name=None, opacity=None, path=None, templateitemname=None, type=None, x0=None, x1=None, xref=None, y0=None, y1=None, yref=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new selection to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Selection or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.layout.selection.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the selection.
| path
| For `type` "path" - a valid SVG path similar to
| `shapes.path` in data coordinates. Allowed segments
| are: M, L and Z.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the selection type to be drawn. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom
| SVG path using `path`.
| x0
| Sets the selection's starting x position.
| x1
| Sets the selection's end x position.
| xref
| Sets the selection's x coordinate axis. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position refers to
| a x coordinate. If set to "paper", the `x` position
| refers to the distance from the left of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| y0
| Sets the selection's starting y position.
| y1
| Sets the selection's end y position.
| yref
| Sets the selection's x coordinate axis. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position refers to
| a y coordinate. If set to "paper", the `y` position
| refers to the distance from the bottom of the plotting
| area in normalized coordinates where 0 (1) corresponds
| to the bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| row
| Subplot row for selection. If 'all', addresses all rows
| in the specified column(s).
| col
| Subplot column for selection. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add selection to secondary y-axis
| exclude_empty_subplots
| If True, selection will not be added to subplots
| without traces.
|
| Returns
| -------
| FigureWidget
|
| add_shape(self, arg=None, editable=None, fillcolor=None, fillrule=None, label=None, layer=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, name=None, opacity=None, path=None, showlegend=None, templateitemname=None, type=None, visible=None, x0=None, x0shift=None, x1=None, x1shift=None, xanchor=None, xref=None, xsizemode=None, y0=None, y0shift=None, y1=None, y1shift=None, yanchor=None, yref=None, ysizemode=None, row=None, col=None, secondary_y=None, exclude_empty_subplots=None, **kwargs) -> 'FigureWidget'
| Create and add a new shape to the figure's layout
|
| Parameters
| ----------
| arg
| instance of Shape or dict with compatible properties
| editable
| Determines whether the shape could be activated for
| edit or not. Has no effect when the older editable
| shapes mode is enabled via `config.editable` or
| `config.edits.shapePosition`.
| fillcolor
| Sets the color filling the shape's interior. Only
| applies to closed shapes.
| fillrule
| Determines which regions of complex paths constitute
| the interior. For more info please visit
| https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.shape.Label`
| instance or dict with compatible properties
| layer
| Specifies whether shapes are drawn below gridlines
| ("below"), between gridlines and traces ("between") or
| above traces ("above").
| legend
| Sets the reference to a legend to show this shape in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this shape. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.shape.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this shape. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this shape.
| line
| :class:`plotly.graph_objects.layout.shape.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are created in the
| output figure in addition to any items the figure
| already has in this array. You can modify these items
| in the output figure by making your own item with
| `templateitemname` matching this `name` alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). Has no effect outside of a
| template.
| opacity
| Sets the opacity of the shape.
| path
| For `type` "path" - a valid SVG path with the pixel
| values replaced by data values in
| `xsizemode`/`ysizemode` being "scaled" and taken
| unmodified as pixels relative to `xanchor` and
| `yanchor` in case of "pixel" size mode. There are a few
| restrictions / quirks only absolute instructions, not
| relative. So the allowed segments are: M, L, H, V, Q,
| C, T, S, and Z arcs (A) are not allowed because radius
| rx and ry are relative. In the future we could consider
| supporting relative commands, but we would have to
| decide on how to handle date and log axes. Note that
| even as is, Q and C Bezier paths that are smooth on
| linear axes may not be smooth on log, and vice versa.
| no chained "polybezier" commands - specify the segment
| type for each one. On category axes, values are numbers
| scaled to the serial numbers of categories because
| using the categories themselves there would be no way
| to describe fractional positions On data axes: because
| space and T are both normal components of path strings,
| we can't use either to separate date from time parts.
| Therefore we'll use underscore for this purpose:
| 2015-02-21_13:45:56.789
| showlegend
| Determines whether or not this shape is shown in the
| legend.
| templateitemname
| Used to refer to a named item in this array in the
| template. Named items from the template will be created
| even without a matching item in the input figure, but
| you can modify one by making an item with
| `templateitemname` matching its `name`, alongside your
| modifications (including `visible: false` or `enabled:
| false` to hide it). If there is no template or no
| matching item, this item will be hidden unless you
| explicitly show it with `visible: true`.
| type
| Specifies the shape type to be drawn. If "line", a line
| is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect
| to the axes' sizing mode. If "circle", a circle is
| drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius
| (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with
| respect to the axes' sizing mode. If "rect", a
| rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`),
| (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to
| the axes' sizing mode. If "path", draw a custom SVG
| path using `path`. with respect to the axes' sizing
| mode.
| visible
| Determines whether or not this shape is visible. If
| "legendonly", the shape is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Sets the shape's starting x position. See `type` and
| `xsizemode` for more info.
| x0shift
| Shifts `x0` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| x1
| Sets the shape's end x position. See `type` and
| `xsizemode` for more info.
| x1shift
| Shifts `x1` away from the center of the category when
| `xref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| xanchor
| Only relevant in conjunction with `xsizemode` set to
| "pixel". Specifies the anchor point on the x axis to
| which `x0`, `x1` and x coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `xsizemode` not
| set to "pixel".
| xref
| Sets the shape's x coordinate axis. If set to a x axis
| id (e.g. "x" or "x2"), the `x` position refers to a x
| coordinate. If set to "paper", the `x` position refers
| to the distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| left (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the left of the
| domain of that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position of 0.5
| refers to the point between the left and the right of
| the domain of the second x axis.
| xsizemode
| Sets the shapes's sizing mode along the x axis. If set
| to "scaled", `x0`, `x1` and x coordinates within `path`
| refer to data values on the x axis or a fraction of the
| plot area's width (`xref` set to "paper"). If set to
| "pixel", `xanchor` specifies the x position in terms of
| data or plot fraction but `x0`, `x1` and x coordinates
| within `path` are pixels relative to `xanchor`. This
| way, the shape can have a fixed width while maintaining
| a position relative to data or plot fraction.
| y0
| Sets the shape's starting y position. See `type` and
| `ysizemode` for more info.
| y0shift
| Shifts `y0` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| y1
| Sets the shape's end y position. See `type` and
| `ysizemode` for more info.
| y1shift
| Shifts `y1` away from the center of the category when
| `yref` is a "category" or "multicategory" axis. -0.5
| corresponds to the start of the category and 0.5
| corresponds to the end of the category.
| yanchor
| Only relevant in conjunction with `ysizemode` set to
| "pixel". Specifies the anchor point on the y axis to
| which `y0`, `y1` and y coordinates within `path` are
| relative to. E.g. useful to attach a pixel sized shape
| to a certain data value. No effect when `ysizemode` not
| set to "pixel".
| yref
| Sets the shape's y coordinate axis. If set to a y axis
| id (e.g. "y" or "y2"), the `y` position refers to a y
| coordinate. If set to "paper", the `y` position refers
| to the distance from the bottom of the plotting area in
| normalized coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position behaves
| like for "paper", but refers to the distance in
| fractions of the domain length from the bottom of the
| domain of that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position of 0.5
| refers to the point between the bottom and the top of
| the domain of the second y axis.
| ysizemode
| Sets the shapes's sizing mode along the y axis. If set
| to "scaled", `y0`, `y1` and y coordinates within `path`
| refer to data values on the y axis or a fraction of the
| plot area's height (`yref` set to "paper"). If set to
| "pixel", `yanchor` specifies the y position in terms of
| data or plot fraction but `y0`, `y1` and y coordinates
| within `path` are pixels relative to `yanchor`. This
| way, the shape can have a fixed height while
| maintaining a position relative to data or plot
| fraction.
| row
| Subplot row for shape. If 'all', addresses all rows in
| the specified column(s).
| col
| Subplot column for shape. If 'all', addresses all
| columns in the specified row(s).
| secondary_y
| Whether to add shape to secondary y-axis
| exclude_empty_subplots
| If True, shape will not be added to subplots without
| traces.
|
| Returns
| -------
| FigureWidget
|
| add_splom(self, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Splom trace
|
| Splom traces generate scatter plot matrix visualizations. Each
| splom `dimensions` items correspond to a generated axis. Values
| for each of those dimensions are set in `dimensions[i].values`.
| Splom traces support all `scattergl` marker style attributes.
| Specify `layout.grid` attributes and/or layout x-axis and
| y-axis attributes for more control over the axis positioning
| and style.
|
| Parameters
| ----------
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| diagonal
| :class:`plotly.graph_objects.splom.Diagonal` instance
| or dict with compatible properties
| dimensions
| A tuple of
| :class:`plotly.graph_objects.splom.Dimension` instances
| or dicts with compatible properties
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the
| default property values to use for elements of
| splom.dimensions
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.splom.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.splom.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.splom.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.splom.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showlowerhalf
| Determines whether or not subplots on the lower half
| from the diagonal are displayed.
| showupperhalf
| Determines whether or not subplots on the upper half
| from the diagonal are displayed.
| stream
| :class:`plotly.graph_objects.splom.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair to
| appear on hover. If a single string, the same string
| appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.splom.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxes
| Sets the list of x axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N xaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| yaxes
| Sets the list of y axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N yaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_streamtube(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Streamtube trace
|
| Use a streamtube trace to visualize flow in a vector field.
| Specify a vector field using 6 1D arrays of equal length, 3
| position arrays `x`, `y` and `z` and 3 vector component arrays
| `u`, `v`, and `w`. By default, the tubes' starting positions
| will be cut from the vector field's x-z plane at its minimum y
| value. To specify your own starting position, use attributes
| `starts.x`, `starts.y` and `starts.z`. The color is encoded by
| the norm of (u, v, w), and the local radius by the divergence
| of (u, v, w).
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.streamtube.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.streamtube.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `tubex`, `tubey`, `tubez`, `tubeu`,
| `tubev`, `tubew`, `norm` and `divergence`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.streamtube.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.streamtube.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.streamtube.Lightposition`
| instance or dict with compatible properties
| maxdisplayed
| The maximum number of displayed segments in a
| streamtube.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizeref
| The scaling factor for the streamtubes. The default is
| 1, which avoids two max divergence tubes from touching
| at adjacent starting positions.
| starts
| :class:`plotly.graph_objects.streamtube.Starts`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.streamtube.Stream`
| instance or dict with compatible properties
| text
| Sets a text element associated with this trace. If
| trace `hoverinfo` contains a "text" flag, this text
| element will be seen in all hover labels. Note that
| streamtube traces do not support array `text` values.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_sunburst(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Sunburst trace
|
| Visualize hierarchal data spanning outward radially from root
| to leaves. The sunburst sectors are determined by the entries
| in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sunburst.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.sunburst.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.sunburst.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sunburst.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.sunburst.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented at the center of a sunburst graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| root
| :class:`plotly.graph_objects.sunburst.Root` instance or
| dict with compatible properties
| rotation
| Rotates the whole diagram counterclockwise by some
| angle. By default the first slice starts at 3 o'clock.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.sunburst.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_surface(self, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Surface trace
|
| The data the describes the coordinates of the surface is set in
| `z`. Data in `z` should be a 2D list. Coordinates in `x` and
| `y` can either be 1D lists or 2D lists (e.g. to graph
| parametric surfaces). If not provided in `x` and `y`, the x and
| y coordinates are assumed to be linear starting at 0 with a
| unit step. The color scale corresponds to the `z` values by
| default. For custom color scales, use `surfacecolor` which
| should be a 2D list, where its bounds can be controlled using
| `cmin` and `cmax`.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here z or surfacecolor)
| or the bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as z or surfacecolor.
| Has no effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmax` must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.surface.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| :class:`plotly.graph_objects.surface.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hidesurface
| Determines whether or not a surface is drawn. For
| example, set `hidesurface` to False `contours.x.show`
| to True and `contours.y.show` to True to draw a wire
| frame plot.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.surface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.surface.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.surface.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.surface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.surface.Stream` instance
| or dict with compatible properties
| surfacecolor
| Sets the surface color values, used for setting a color
| scale independent of `z`.
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
| text
| Sets the text elements associated with each z value. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| 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, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Table trace
|
| Table view for detailed data viewing. The data are arranged in
| a grid of rows and columns. Most styling can be specified for
| columns, rows or individual cells. Table is using a column-
| major order, ie. the grid is represented as a vector of column
| vectors.
|
| Parameters
| ----------
| cells
| :class:`plotly.graph_objects.table.Cells` instance or
| dict with compatible properties
| columnorder
| Specifies the rendered order of the data columns; for
| example, a value `2` at position `0` means that column
| index `0` in the data will be rendered as the third
| column, as columns have an index base of zero.
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
| columnwidth
| The width of columns expressed as a ratio. Columns fill
| the available width in proportion of their specified
| column widths.
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.table.Domain` instance or
| dict with compatible properties
| header
| :class:`plotly.graph_objects.table.Header` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.table.Hoverlabel` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.table.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| stream
| :class:`plotly.graph_objects.table.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_trace(self, trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False) -> 'FigureWidget'
| 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 : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.
| If 'all', addresses all columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
| * The trace argument is a 2D cartesian trace
| (scatter, bar, etc.)
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
| Returns
| -------
| BaseFigure
| The Figure that add_trace was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS
| Figure(...)
|
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) # doctest: +ELLIPSIS
| Figure(...)
|
| add_traces(self, data, rows=None, cols=None, secondary_ys=None, exclude_empty_subplots=False) -> 'FigureWidget'
| Add traces to the figure
|
| Parameters
| ----------
| data : list[BaseTraceType or dict]
| A list of trace specifications to be added.
| Trace specifications may be either:
|
| - Instances of trace classes from the plotly.graph_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, list[int], or int (default None)
| List of subplot row indexes (starting from 1) for the traces to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to row number
|
| cols : None or list[int] (default None)
| List of subplot column indexes (starting from 1) for the traces
| to be added. Only valid if figure was created using
| `plotly.tools.make_subplots`
| If a single integer is passed, all traces will be added to column number
|
|
| secondary_ys: None or list[boolean] (default None)
| List of secondary_y booleans for traces to be added. See the
| docstring for `add_trace` for more info.
|
| exclude_empty_subplots: boolean
| If True, the trace will not be added to subplots that don't already
| have traces.
|
| Returns
| -------
| BaseFigure
| The Figure that add_traces was called on
|
| Examples
| --------
|
| >>> from plotly import subplots
| >>> 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])]) # doctest: +ELLIPSIS
| Figure(...)
|
| Add two Scatter traces to vertically stacked subplots
|
| >>> fig = subplots.make_subplots(rows=2)
| >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]),
| ... go.Scatter(x=[1,2,3], y=[2,1,2])],
| ... rows=[1, 2], cols=[1, 1]) # doctest: +ELLIPSIS
| Figure(...)
|
| add_treemap(self, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Treemap trace
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The treemap sectors are
| determined by the entries in "labels" or "ids" and in
| "parents".
|
| Parameters
| ----------
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.treemap.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.treemap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.treemap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.treemap.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.treemap.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.treemap.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.treemap.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.treemap.Tiling` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_violin(self, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Violin trace
|
| In vertical (horizontal) violin plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| violin per distinct x (y) value is drawn If no `x` (`y`) list
| is provided, a single violin is drawn. That violin position is
| then positioned with with `name` or with `x0` (`y0`) if
| provided.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| bandwidth
| Sets the bandwidth used to compute the kernel density
| estimate. By default, the bandwidth is determined by
| Silverman's rule of thumb.
| box
| :class:`plotly.graph_objects.violin.Box` instance or
| dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.violin.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual violins or
| sample points or the kernel density estimate or any
| combination of them?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the violins.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.violin.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.violin.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.violin.Marker` instance or
| dict with compatible properties
| meanline
| :class:`plotly.graph_objects.violin.Meanline` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For violin traces, the name
| will also be used for the position coordinate, if `x`
| and `x0` (`y` and `y0` if horizontal) are missing and
| the position axis is categorical. Note that the trace
| name is also used as a default value for attribute
| `scalegroup` (please see its description for details).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the violin(s). If "v" ("h"),
| the distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the violins. If 0, the sample points are places over
| the center of the violins. Positive (negative) values
| correspond to positions to the right (left) for
| vertical violins and above (below) for horizontal
| violins.
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the violins are shown with no sample
| points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set, otherwise defaults to "outliers".
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| scalegroup
| If there are multiple violins that should be sized
| according to to some metric (see `scalemode`), link
| them by providing a non-empty group id here shared by
| every trace in the same group. If a violin's `width` is
| undefined, `scalegroup` will default to the trace's
| name. In this case, violins with the same names will be
| linked together
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same
| (max) width "count" means the violins are scaled by the
| number of sample points making up each violin.
| selected
| :class:`plotly.graph_objects.violin.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| side
| Determines on which side of the position value the
| density function making up one half of a violin is
| plotted. Useful when comparing two violin traces under
| "overlay" mode, where one trace has `side` set to
| "positive" and the other to "negative".
| span
| Sets the span in data space for which the density
| function will be computed. Has an effect only when
| `spanmode` is set to "manual".
| spanmode
| Sets the method by which the span in data space where
| the density function will be computed. "soft" means the
| span goes from the sample's minimum value minus two
| bandwidths to the sample's maximum value plus two
| bandwidths. "hard" means the span goes from the
| sample's minimum to its maximum value. For custom span
| settings, use mode "manual" and fill in the `span`
| attribute.
| stream
| :class:`plotly.graph_objects.violin.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.violin.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the width of the violin in data coordinates. If 0
| (default value) the width is automatically selected
| based on the positions of other violin traces in the
| same subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| add_vline(self, x, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a vertical line to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x: float or int
| A number representing the x coordinate of the vertical line.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the line. Example positions are "bottom left", "right top",
| "right", "bottom". If an annotation is added but annotation_position is
| not specified, this defaults to "top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_volume(self, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, row=None, col=None, **kwargs) -> 'FigureWidget'
| Add a new Volume trace
|
| Draws volume trace between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.volume.Caps` instance or
| dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.volume.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.volume.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.volume.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.volume.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.volume.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.volume.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.volume.Slices` instance or
| dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.volume.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.volume.Stream` instance or
| dict with compatible properties
| surface
| :class:`plotly.graph_objects.volume.Surface` instance
| or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
|
| Returns
| -------
| FigureWidget
|
| add_vrect(self, x0, x1, row='all', col='all', exclude_empty_subplots=True, annotation=None, **kwargs) -> 'FigureWidget'
| Add a rectangle to a plot or subplot that extends infinitely in the
| y-dimension.
|
| Parameters
| ----------
| x0: float or int
| A number representing the x coordinate of one side of the rectangle.
| x1: float or int
| A number representing the x coordinate of the other side of the rectangle.
| exclude_empty_subplots: Boolean
| If True (default) do not place the shape on subplots that have no data
| plotted on them.
| row: None, int or 'all'
| Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| col: None, int or 'all'
| Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
| the specified column(s). If both row and col are None, addresses the
| first subplot if subplots exist, or the only plot. By default is "all".
| annotation: dict or plotly.graph_objects.layout.Annotation. If dict(),
| it is interpreted as describing an annotation. The annotation is
| placed relative to the shape based on annotation_position (see
| below) unless its x or y value has been specified for the annotation
| passed here. xref and yref are always the same as for the added
| shape and cannot be overridden.
| annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
| and ["left", "right"] specifying where the text should be anchored
| to on the rectangle. Example positions are "outside top left", "inside
| bottom", "right", "inside left", "inside" ("outside" is not supported). If
| an annotation is added but annotation_position is not specified this
| defaults to "inside top right".
| annotation_*: any parameters to go.layout.Annotation can be passed as
| keywords by prefixing them with "annotation_". For example, to specify the
| annotation text "example" you can pass annotation_text="example" as a
| keyword argument.
| **kwargs:
| Any named function parameters that can be passed to 'add_shape',
| except for x0, x1, y0, y1 or type.
|
| add_waterfall(self, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Add a new Waterfall trace
|
| Draws waterfall trace which is useful graph to displays the
| contribution of various elements (either positive or negative)
| in a bar chart. The data visualized by the span of the bars is
| set in `y` if `orientation` is set to "v" (the default) and the
| labels are set in `x`. By setting `orientation` to "h", the
| roles are interchanged.
|
| Parameters
| ----------
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units).
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.waterfall.Connector`
| instance or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.waterfall.Decreasing`
| instance or dict with compatible properties
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.waterfall.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta` and `final`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.waterfall.Increasing`
| instance or dict with compatible properties
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.waterfall.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| measure
| An array containing types of values. By default the
| values are considered as 'relative'. However; it is
| possible to use 'total' to compute the sums. Also
| 'absolute' could be applied to reset the computed total
| or to declare an initial value where needed.
| measuresrc
| Sets the source reference on Chart Studio Cloud for
| `measure`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.waterfall.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple waterfalls, totals are
| computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta`, `final` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| totals
| :class:`plotly.graph_objects.waterfall.Totals` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| row : 'all', int or None (default)
| Subplot row index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| rows in the specified column(s).
| col : 'all', int or None (default)
| Subplot col index (starting from 1) for the trace to be
| added. Only valid if figure was created using
| `plotly.tools.make_subplots`.If 'all', addresses all
| columns in the specified row(s).
| secondary_y: boolean or None (default None)
| If True, associate this trace with the secondary y-axis of the
| subplot at the specified row and col. Only valid if all of the
| following conditions are satisfied:
| * The figure was created using `plotly.subplots.make_subplots`.
| * The row and col arguments are not None
| * The subplot at the specified row and col has type xy
| (which is the default) and secondary_y True. These
| properties are specified in the specs argument to
| make_subplots. See the make_subplots docstring for more info.
|
| Returns
| -------
| FigureWidget
|
| for_each_annotation(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all annotations that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single annotation object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotations that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_coloraxis(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all coloraxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single coloraxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_geo(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all geo objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single geo object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_layout_image(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all images that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single image object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| images that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_legend(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all legend objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single legend object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_map(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all map objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single map object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_mapbox(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all mapbox objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single mapbox object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_polar(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all polar objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single polar object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_scene(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all scene objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single scene object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_selection(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all selections that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single selection object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selections that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_shape(self, fn, selector=None, row=None, col=None, secondary_y=None)
| Apply a function to all shapes that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single shape object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shapes that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_smith(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all smith objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single smith object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_ternary(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all ternary objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single ternary object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_trace(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'FigureWidget'
| Apply a function to all traces that satisfy the specified selection
| criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single trace object.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| for_each_xaxis(self, fn, selector=None, row=None, col=None) -> 'FigureWidget'
| Apply a function to all xaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single xaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None) -> 'FigureWidget'
| Apply a function to all yaxis objects that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| fn:
| Function that inputs a single yaxis object.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| select_annotations(self, selector=None, row=None, col=None, secondary_y=None)
| Select annotations from a particular subplot cell and/or annotations
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the annotations that satisfy
| all of the specified selection criteria
|
| select_coloraxes(self, selector=None, row=None, col=None)
| Select coloraxis subplot objects from a particular subplot cell
| and/or coloraxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the coloraxis
| objects that satisfy all of the specified selection criteria
|
| select_geos(self, selector=None, row=None, col=None)
| Select geo subplot objects from a particular subplot cell
| and/or geo subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the geo
| objects that satisfy all of the specified selection criteria
|
| select_layout_images(self, selector=None, row=None, col=None, secondary_y=None)
| Select images from a particular subplot cell and/or images
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the images that satisfy
| all of the specified selection criteria
|
| select_legends(self, selector=None, row=None, col=None)
| Select legend subplot objects from a particular subplot cell
| and/or legend subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the legend
| objects that satisfy all of the specified selection criteria
|
| select_mapboxes(self, selector=None, row=None, col=None)
| Select mapbox subplot objects from a particular subplot cell
| and/or mapbox subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the mapbox
| objects that satisfy all of the specified selection criteria
|
| select_maps(self, selector=None, row=None, col=None)
| Select map subplot objects from a particular subplot cell
| and/or map subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the map
| objects that satisfy all of the specified selection criteria
|
| select_polars(self, selector=None, row=None, col=None)
| Select polar subplot objects from a particular subplot cell
| and/or polar subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the polar
| objects that satisfy all of the specified selection criteria
|
| select_scenes(self, selector=None, row=None, col=None)
| Select scene subplot objects from a particular subplot cell
| and/or scene subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the scene
| objects that satisfy all of the specified selection criteria
|
| select_selections(self, selector=None, row=None, col=None, secondary_y=None)
| Select selections from a particular subplot cell and/or selections
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the selections that satisfy
| all of the specified selection criteria
|
| select_shapes(self, selector=None, row=None, col=None, secondary_y=None)
| Select shapes from a particular subplot cell and/or shapes
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str, or None (default None)
| Dict to use as selection criteria.
| Annotations will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the shapes that satisfy
| all of the specified selection criteria
|
| select_smiths(self, selector=None, row=None, col=None)
| Select smith subplot objects from a particular subplot cell
| and/or smith subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the smith
| objects that satisfy all of the specified selection criteria
|
| select_ternaries(self, selector=None, row=None, col=None)
| Select ternary subplot objects from a particular subplot cell
| and/or ternary subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the ternary
| objects that satisfy all of the specified selection criteria
|
| select_xaxes(self, selector=None, row=None, col=None)
| Select xaxis subplot objects from a particular subplot cell
| and/or xaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| Returns
| -------
| generator
| Generator that iterates through all of the xaxis
| objects that satisfy all of the specified selection criteria
|
| select_yaxes(self, selector=None, row=None, col=None, secondary_y=None)
| Select yaxis subplot objects from a particular subplot cell
| and/or yaxis subplot objects that satisfy custom selection
| criteria.
|
| Parameters
| ----------
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the yaxis
| objects that satisfy all of the specified selection criteria
|
| set_subplots(self, rows=None, cols=None, **make_subplots_args) -> 'FigureWidget'
| Add subplots to this figure. If the figure already contains subplots,
| then this throws an error. Accepts any keyword arguments that
| plotly.subplots.make_subplots accepts.
|
| update(self, dict1=None, overwrite=False, **kwargs) -> 'FigureWidget'
| Update the properties of the figure with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the figure
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Examples
| --------
| >>> import plotly.graph_objs as go
| >>> fig = go.Figure(data=[{'y': [1, 2, 3]}])
| >>> fig.update(data=[{'y': [4, 5, 6]}]) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'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'}}}) # doctest: +ELLIPSIS
| Figure(...)
| >>> fig.to_plotly_json() # doctest: +SKIP
| {'data': [],
| 'layout': {'xaxis':
| {'color': 'pink',
| 'range': [0, 1]}}}
|
| Returns
| -------
| BaseFigure
| Updated figure
|
| update_annotations(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all annotations that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all annotations that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all annotations are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each annotation and those for which the function returned True
| will be in the selection. If an int N, the Nth annotation matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of annotations to select.
| To select annotations by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| annotation that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all annotations are selected.
| secondary_y: boolean or None (default None)
| * If True, only select annotations associated with the secondary
| y-axis of the subplot.
| * If False, only select annotations associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter annotations based on secondary
| y-axis.
|
| To select annotations by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected annotation. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_coloraxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all coloraxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| coloraxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| coloraxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all coloraxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| coloraxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of coloraxis objects to select.
| To select coloraxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all coloraxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| coloraxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_geos(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all geo objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| geo objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| geo objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all geo objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| geo and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of geo objects to select.
| To select geo objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all geo objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| geo object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_layout(self, dict1=None, overwrite=False, **kwargs) -> 'FigureWidget'
| Update the properties of the figure's layout with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| layout with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BaseFigure
| The Figure object that the update_layout method was called on
|
| update_layout_images(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all images that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all images that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all images are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each image and those for which the function returned True
| will be in the selection. If an int N, the Nth image matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of images to select.
| To select images by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| image that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all images are selected.
| secondary_y: boolean or None (default None)
| * If True, only select images associated with the secondary
| y-axis of the subplot.
| * If False, only select images associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter images based on secondary
| y-axis.
|
| To select images by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected image. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_legends(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all legend objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| legend objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| legend objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all legend objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| legend and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of legend objects to select.
| To select legend objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all legend objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| legend object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_mapboxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all mapbox objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| mapbox objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| mapbox objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all mapbox objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| mapbox and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of mapbox objects to select.
| To select mapbox objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all mapbox objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| mapbox object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_maps(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all map objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| map objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| map objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all map objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| map and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of map objects to select.
| To select map objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all map objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| map object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_polars(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all polar objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| polar objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| polar objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all polar objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| polar and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of polar objects to select.
| To select polar objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all polar objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| polar object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_scenes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all scene objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| scene objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| scene objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all scene objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| scene and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of scene objects to select.
| To select scene objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all scene objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| scene object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_selections(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all selections that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all selections that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all selections are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each selection and those for which the function returned True
| will be in the selection. If an int N, the Nth selection matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of selections to select.
| To select selections by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| selection that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all selections are selected.
| secondary_y: boolean or None (default None)
| * If True, only select selections associated with the secondary
| y-axis of the subplot.
| * If False, only select selections associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter selections based on secondary
| y-axis.
|
| To select selections by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected selection. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_shapes(self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all shapes that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all shapes that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all shapes are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each shape and those for which the function returned True
| will be in the selection. If an int N, the Nth shape matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of shapes to select.
| To select shapes by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. To select only those
| shape that are in paper coordinates, set row and col to the
| string 'paper'. If None (the default), all shapes are selected.
| secondary_y: boolean or None (default None)
| * If True, only select shapes associated with the secondary
| y-axis of the subplot.
| * If False, only select shapes associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter shapes based on secondary
| y-axis.
|
| To select shapes by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected shape. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_smiths(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all smith objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| smith objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| smith objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all smith objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| smith and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of smith objects to select.
| To select smith objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all smith objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| smith object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_ternaries(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all ternary objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| ternary objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| ternary objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all ternary objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| ternary and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of ternary objects to select.
| To select ternary objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all ternary objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| ternary object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_traces(self, patch=None, selector=None, row=None, col=None, secondary_y=None, overwrite=False, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all traces that satisfy the
| specified selection criteria
|
| Parameters
| ----------
| patch: dict or None (default None)
| Dictionary of property updates to be applied to all traces that
| satisfy the selection criteria.
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| **kwargs
| Additional property updates to apply to each selected trace. If
| a property is specified in both patch and in **kwargs then the
| one in **kwargs takes precedence.
|
| Returns
| -------
| self
| Returns the Figure object that the method was called on
|
| update_xaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all xaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| xaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| xaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all xaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| xaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of xaxis objects to select.
| To select xaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all xaxis objects are selected.
| **kwargs
| Additional property updates to apply to each selected
| xaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| update_yaxes(self, patch=None, selector=None, overwrite=False, row=None, col=None, secondary_y=None, **kwargs) -> 'FigureWidget'
| Perform a property update operation on all yaxis objects
| that satisfy the specified selection criteria
|
| Parameters
| ----------
| patch: dict
| Dictionary of property updates to be applied to all
| yaxis objects that satisfy the selection criteria.
| selector: dict, function, or None (default None)
| Dict to use as selection criteria.
| yaxis objects will be selected if they contain
| properties corresponding to all of the dictionary's keys, with
| values that exactly match the supplied values. If None
| (the default), all yaxis objects are selected. If a
| function, it must be a function accepting a single argument and
| returning a boolean. The function will be called on each
| yaxis and those for which the function returned True will
| be in the selection.
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| row, col: int or None (default None)
| Subplot row and column index of yaxis objects to select.
| To select yaxis objects by row and column, the Figure
| must have been created using plotly.subplots.make_subplots.
| If None (the default), all yaxis objects are selected.
| secondary_y: boolean or None (default None)
| * If True, only select yaxis objects associated with the secondary
| y-axis of the subplot.
| * If False, only select yaxis objects associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter yaxis objects based on
| a secondary y-axis condition.
|
| To select yaxis objects by secondary y-axis, the Figure must
| have been created using plotly.subplots.make_subplots. See
| the docstring for the specs argument to make_subplots for more
| info on creating subplots with secondary y-axes.
| **kwargs
| Additional property updates to apply to each selected
| yaxis object. If a property is specified in
| both patch and in **kwargs then the one in **kwargs
| takes precedence.
| Returns
| -------
| self
| Returns the FigureWidget object that the method was called on
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| 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
| The `frames` property is a tuple of the figure's frame objects
|
| Returns
| -------
| tuple[plotly.graph_objs.Frame]
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFigure:
|
| __contains__(self, prop)
|
| __eq__(self, other)
| Return self==value.
|
| __getitem__(self, prop)
|
| __iter__(self)
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __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)
|
| 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(self, duration=500, easing='cubic-in-out')
| 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_animate(duration=2000, easing='elastic-in-out'):
| ... fig.data[0].marker.color = 'green'
| ... fig.data[0].marker.size = 20
|
| batch_update(self)
| 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.
|
| full_figure_for_development(self, warn=True, as_dict=False)
| Compute default values for all attributes not specified in the input figure and
| returns the output as a "full" figure. This function calls Plotly.js via Kaleido
| to populate unspecified attributes. This function is intended for interactive use
| during development to learn more about how Plotly.js computes default values and is
| not generally necessary or recommended for production use.
|
| Parameters
| ----------
| fig:
| Figure object or dict representing a figure
|
| warn: bool
| If False, suppress warnings about not using this in production.
|
| as_dict: bool
| If True, output is a dict with some keys that go.Figure can't parse.
| If False, output is a go.Figure with unparseable keys skipped.
|
| Returns
| -------
| plotly.graph_objects.Figure or dict
| The full figure
|
| get_subplot(self, row, col, secondary_y=False)
| Return an object representing the subplot at the specified row
| and column. May only be used on Figures created using
| plotly.tools.make_subplots
|
| Parameters
| ----------
| row: int
| 1-based index of subplot row
| col: int
| 1-based index of subplot column
| secondary_y: bool
| If True, select the subplot that consists of the x-axis and the
| secondary y-axis at the specified row/col. Only valid if the
| subplot at row/col is an 2D cartesian subplot that was created
| with a secondary y-axis. See the docstring for the specs argument
| to make_subplots for more info on creating a subplot with a
| secondary y-axis.
| Returns
| -------
| subplot
| * None: if subplot is empty
| * plotly.graph_objs.layout.Scene: if subplot type is 'scene'
| * plotly.graph_objs.layout.Polar: if subplot type is 'polar'
| * plotly.graph_objs.layout.Ternary: if subplot type is 'ternary'
| * plotly.graph_objs.layout.Mapbox: if subplot type is 'ternary'
| * SubplotDomain namedtuple with `x` and `y` fields:
| if subplot type is 'domain'.
| - x: length 2 list of the subplot start and stop width
| - y: length 2 list of the subplot start and stop height
| * SubplotXY namedtuple with `xaxis` and `yaxis` fields:
| if subplot type is 'xy'.
| - xaxis: plotly.graph_objs.layout.XAxis instance for subplot
| - yaxis: plotly.graph_objs.layout.YAxis instance for subplot
|
| 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]
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[2, 4, 6]))
| >>> 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
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in figure
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| 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.
|
| select_traces(self, selector=None, row=None, col=None, secondary_y=None)
| Select traces from a particular subplot cell and/or traces
| that satisfy custom selection criteria.
|
| Parameters
| ----------
| selector: dict, function, int, str or None (default None)
| Dict to use as selection criteria.
| Traces will be selected if they contain properties corresponding
| to all of the dictionary's keys, with values that exactly match
| the supplied values. If None (the default), all traces are
| selected. If a function, it must be a function accepting a single
| argument and returning a boolean. The function will be called on
| each trace and those for which the function returned True
| will be in the selection. If an int N, the Nth trace matching row
| and col will be selected (N can be negative). If a string S, the selector
| is equivalent to dict(type=S).
| row, col: int or None (default None)
| Subplot row and column index of traces to select.
| To select traces by row and column, the Figure must have been
| created using plotly.subplots.make_subplots. If None
| (the default), all traces are selected.
| secondary_y: boolean or None (default None)
| * If True, only select traces associated with the secondary
| y-axis of the subplot.
| * If False, only select traces associated with the primary
| y-axis of the subplot.
| * If None (the default), do not filter traces based on secondary
| y-axis.
|
| To select traces by secondary y-axis, the Figure must have been
| created using plotly.subplots.make_subplots. See the docstring
| for the specs argument to make_subplots for more info on
| creating subplots with secondary y-axes.
| Returns
| -------
| generator
| Generator that iterates through all of the traces that satisfy
| all of the specified selection criteria
|
| show(self, *args, **kwargs)
| Show a figure using either the default renderer(s) or the renderer(s)
| specified by the renderer argument
|
| Parameters
| ----------
| renderer: str or None (default None)
| A string containing the names of one or more registered renderers
| (separated by '+' characters) or None. If None, then the default
| renderers specified in plotly.io.renderers.default are used.
|
| validate: bool (default True)
| True if the figure should be validated before being shown,
| False otherwise.
|
| width: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| height: int or float
| An integer or float that determines the number of pixels wide the
| plot is. The default is set in plotly.js.
|
| config: dict
| A dict of parameters to configure the figure. The defaults are set
| in plotly.js.
|
| Returns
| -------
| None
|
| 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_html(self, *args, **kwargs)
| Convert a figure to an HTML string representation.
|
| Parameters
| ----------
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| str
| Representation of figure as an HTML div string
|
| to_image(self, *args, **kwargs)
| Convert a figure to a static image bytes string
|
| Parameters
| ----------
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified, will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
|
| Returns
| -------
| bytes
| The image data
|
| to_json(self, *args, **kwargs)
| Convert a figure to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of figure as a JSON string
|
| to_ordered_dict(self, skip_uid=True)
|
| to_plotly_json(self)
| Convert figure to a JSON representation as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| write_html(self, *args, **kwargs)
| Write a figure to an HTML file representation
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
| config: dict or None (default None)
| Plotly.js figure config options
| auto_play: bool (default=True)
| Whether to automatically start the animation sequence on page load
| if the figure contains frames. Has no effect if the figure does not
| contain frames.
| include_plotlyjs: bool or string (default True)
| Specifies how the plotly.js library is included/loaded in the output
| div string.
|
| If True, a script tag containing the plotly.js source code (~3MB)
| is included in the output. HTML files generated with this option are
| fully self-contained and can be used offline.
|
| If 'cdn', a script tag that references the plotly.js CDN is included
| in the output. HTML files generated with this option are about 3MB
| smaller than those generated with include_plotlyjs=True, but they
| require an active internet connection in order to load the plotly.js
| library.
|
| If 'directory', a script tag is included that references an external
| plotly.min.js bundle that is assumed to reside in the same
| directory as the HTML file. If `file` is a string to a local file
| path and `full_html` is True, then the plotly.min.js bundle is copied
| into the directory of the resulting HTML file. If a file named
| plotly.min.js already exists in the output directory then this file
| is left unmodified and no copy is performed. HTML files generated
| with this option can be used offline, but they require a copy of
| the plotly.min.js bundle in the same directory. This option is
| useful when many figures will be saved as HTML files in the same
| directory because the plotly.js source code will be included only
| once per output directory, rather than once per output file.
|
| If 'require', Plotly.js is loaded using require.js. This option
| assumes that require.js is globally available and that it has been
| globally configured to know how to find Plotly.js as 'plotly'.
| This option is not advised when full_html=True as it will result
| in a non-functional html file.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point
| the resulting HTML file to an alternative CDN or local bundle.
|
| If False, no script tag referencing plotly.js is included. This is
| useful when the resulting div string will be placed inside an HTML
| document that already loads plotly.js. This option is not advised
| when full_html=True as it will result in a non-functional html file.
|
| include_mathjax: bool or string (default False)
| Specifies how the MathJax.js library is included in the output html
| div string. MathJax is required in order to display labels
| with LaTeX typesetting.
|
| If False, no script tag referencing MathJax.js will be included in the
| output.
|
| If 'cdn', a script tag that references a MathJax CDN location will be
| included in the output. HTML div strings generated with this option
| will be able to display LaTeX typesetting as long as internet access
| is available.
|
| If a string that ends in '.js', a script tag is included that
| references the specified path. This approach can be used to point the
| resulting HTML div string to an alternative CDN.
| post_script: str or list or None (default None)
| JavaScript snippet(s) to be included in the resulting div just after
| plot creation. The string(s) may include '{plot_id}' placeholders
| that will then be replaced by the `id` of the div element that the
| plotly.js figure is associated with. One application for this script
| is to install custom plotly.js event handlers.
| full_html: bool (default True)
| If True, produce a string containing a complete HTML document
| starting with an <html> tag. If False, produce a string containing
| a single <div> element.
| animation_opts: dict or None (default None)
| dict of custom animation parameters to be passed to the function
| Plotly.animate in Plotly.js. See
| https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
| for available options. Has no effect if the figure does not contain
| frames, or auto_play is False.
| default_width, default_height: number or str (default '100%')
| The default figure width/height to use if the provided figure does not
| specify its own layout.width/layout.height property. May be
| specified in pixels as an integer (e.g. 500), or as a css width style
| string (e.g. '500px', '100%').
| validate: bool (default True)
| True if the figure should be validated before being converted to
| JSON, False otherwise.
| auto_open: bool (default True)
| If True, open the saved file in a web browser after saving.
| This argument only applies if `full_html` is True.
| div_id: str (default None)
| If provided, this is the value of the id attribute of the div tag. If None, the
| id attribute is a UUID.
|
| Returns
| -------
| None
|
| write_image(self, *args, **kwargs)
| Convert a figure to a static image and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. a pathlib.Path object or an open file descriptor)
|
| format: str or None
| The desired image format. One of
| - 'png'
| - 'jpg' or 'jpeg'
| - 'webp'
| - 'svg'
| - 'pdf'
| - 'eps' (Requires the poppler library to be installed)
|
| If not specified and `file` is a string then this will default to the
| file extension. If not specified and `file` is not a string then this
| will default to `plotly.io.config.default_format`
|
| width: int or None
| The width of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the width of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_width`
|
| height: int or None
| The height of the exported image in layout pixels. If the `scale`
| property is 1.0, this will also be the height of the exported image
| in physical pixels.
|
| If not specified, will default to `plotly.io.config.default_height`
|
| scale: int or float or None
| The scale factor to use when exporting the figure. A scale factor
| larger than 1.0 will increase the image resolution with respect
| to the figure's layout pixel dimensions. Whereas as scale factor of
| less than 1.0 will decrease the image resolution.
|
| If not specified, will default to `plotly.io.config.default_scale`
|
| validate: bool
| True if the figure should be validated before being converted to
| an image, False otherwise.
|
| engine: str
| Image export engine to use:
| - "kaleido": Use Kaleido for image export
| - "orca": Use Orca for image export
| - "auto" (default): Use Kaleido if installed, otherwise use orca
| Returns
| -------
| None
|
| write_json(self, *args, **kwargs)
| Convert a figure to JSON and write it to a file or writeable
| object
|
| Parameters
| ----------
| file: str or writeable
| A string representing a local file path or a writeable object
| (e.g. an open file descriptor)
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| None
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BaseFigure:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| 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
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BaseFigure:
|
| __hash__ = None
|
| ----------------------------------------------------------------------
| 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.
|
| blur(self)
| Blur the widget.
|
| focus(self)
| Focus on the widget.
|
| 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.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.domwidget.DOMWidget:
|
| tabbable
| Is widget tabbable?
|
| tooltip
| A tooltip caption.
|
| ----------------------------------------------------------------------
| Methods inherited from ipywidgets.widgets.widget.Widget:
|
| __copy__(self)
|
| __deepcopy__(self, memo)
|
| __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(self)
| Hold syncing any state until the outermost context manager exits
|
| notify_change(self, change)
| Called when a property has changed.
|
| 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()
|
| handle_control_comm_opened(comm, msg)
| Class method, called when the comm-open message on the
| "jupyter.widget.control" comm channel is received
|
| ----------------------------------------------------------------------
| 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)
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ipywidgets.widgets.widget.Widget:
|
| model_id
| Gets the model id of this widget.
|
| If a Comm doesn't exist yet, a Comm will be created automagically.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.widget.Widget:
|
| comm
|
| keys
| The traits which are synced.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from ipywidgets.widgets.widget.Widget:
|
| widget_types = <ipywidgets.widgets.widget.WidgetRegistry object>
|
| widgets = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ipywidgets.widgets.widget.LoggingHasTraits:
|
| log
|
| ----------------------------------------------------------------------
| Methods inherited from traitlets.traitlets.HasTraits:
|
| __getstate__(self) -> 'dict[str, t.Any]'
| Helper for pickle.
|
| __setstate__(self, state: 'dict[str, t.Any]') -> 'None'
|
| has_trait(self, name: 'str') -> 'bool'
| Returns True if the object has a trait with the specified name.
|
| hold_trait_notifications(self) -> 't.Any'
| 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: 't.Callable[..., t.Any]', names: 'Sentinel | str | t.Iterable[Sentinel | str]' = traitlets.All, type: 'Sentinel | str' = 'change') -> 'None'
| 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: 'EventHandler | None' = None, name: 'Sentinel | str | None' = None, remove: 'bool' = False) -> 'None'
| 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: 'str', value: 't.Any') -> 'None'
| Forcibly sets trait attribute, including read-only attributes.
|
| setup_instance(*args: 't.Any', **kwargs: 't.Any') -> 'None'
| This is called **before** self.__init__ is called.
|
| trait_defaults(self, *names: 'str', **metadata: 't.Any') -> 'dict[str, t.Any] | Sentinel'
| Return a trait's default value or a dictionary of them
|
| Notes
| -----
| Dynamically generated default values may
| depend on the current state of the object.
|
| trait_has_value(self, name: 'str') -> 'bool'
| Returns True if the specified trait has a value.
|
| This will return false even if ``getattr`` would return a
| dynamically generated default value. These default values
| will be recognized as existing only after they have been
| generated.
|
| Example
|
| .. code-block:: python
|
| class MyClass(HasTraits):
| i = Int()
|
|
| mc = MyClass()
| assert not mc.trait_has_value("i")
| mc.i # generates a default value
| assert mc.trait_has_value("i")
|
| trait_metadata(self, traitname: 'str', key: 'str', default: 't.Any' = None) -> 't.Any'
| Get metadata values for trait by key.
|
| trait_names(self, **metadata: 't.Any') -> 'list[str]'
| Get a list of all the names of this class' traits.
|
| trait_values(self, **metadata: 't.Any') -> 'dict[str, t.Any]'
| A ``dict`` of trait names and their values.
|
| 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.
|
| Returns
| -------
| A ``dict`` of trait names and their values.
|
| Notes
| -----
| Trait values are retrieved via ``getattr``, any exceptions raised
| by traits or the operations they may trigger will result in the
| absence of a trait value in the result ``dict``.
|
| traits(self, **metadata: 't.Any') -> 'dict[str, TraitType[t.Any, t.Any]]'
| 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: 't.Callable[..., t.Any]', names: 'Sentinel | str | t.Iterable[Sentinel | str]' = traitlets.All, type: 'Sentinel | str' = 'change') -> 'None'
| 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: 'str | t.Any' = traitlets.All) -> 'None'
| 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(name: 'str') -> 'dict[str, EventHandler]'
| 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(**metadata: 't.Any') -> 'dict[str, TraitType[t.Any, t.Any]]'
| 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(**metadata: 't.Any') -> 'list[str]'
| 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(**metadata: 't.Any') -> 'dict[str, TraitType[t.Any, t.Any]]'
| 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(name: 'str | None' = None) -> 'dict[str, EventHandler]'
| 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.
|
| ----------------------------------------------------------------------
| Readonly properties 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__(*args: 't.Any', **kwargs: 't.Any') -> 't.Any'
| Create and return a new object. See help(type) for accurate signature.
class Font(builtins.dict)
| Font(*args, **kwargs)
|
| plotly.graph_objs.Font is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Font
| - plotly.graph_objs.layout.hoverlabel.Font
| - etc.
|
| Method resolution order:
| Font
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Font is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Font
| - plotly.graph_objs.layout.hoverlabel.Font
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Frame(plotly.basedatatypes.BaseFrameHierarchyType)
| Frame(arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)
|
| Method resolution order:
| Frame
| plotly.basedatatypes.BaseFrameHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, baseframe=None, data=None, group=None, layout=None, name=None, traces=None, **kwargs)
| Construct a new Frame object
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Frame`
| 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
|
| Returns
| -------
| Frame
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| baseframe
| The name of the frame into which this frame's properties are
| merged before applying. This is used to unify properties and
| avoid needing to specify the same values for the same
| properties in multiple frames.
|
| The 'baseframe' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| data
| A list of traces this frame modifies. The format is identical
| to the normal trace definition.
|
| Returns
| -------
| Any
|
| group
| An identifier that specifies the group to which the frame
| belongs, used by animate to select a subset of frames.
|
| The 'group' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| layout
| Layout properties which this frame modifies. The format is
| identical to the normal layout definition.
|
| Returns
| -------
| Any
|
| name
| A label by which to identify the frame
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| traces
| A list of trace indices that identify the respective traces in
| the data attribute
|
| The 'traces' property accepts values of any type
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseFrameHierarchyType:
|
| on_change(self, callback, *args)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Frames(builtins.list)
| Frames(*args, **kwargs)
|
| plotly.graph_objs.Frames is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Frame
|
| Method resolution order:
| Frames
| builtins.list
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Frames is deprecated.
| Please replace it with a list or tuple of instances of the following types
| - plotly.graph_objs.Frame
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.list:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.list:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.list:
|
| __new__(*args, **kwargs) class method of builtins.list
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.list:
|
| __hash__ = None
class Funnel(plotly.basedatatypes.BaseTraceType)
| Funnel(arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Funnel
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Funnel object
|
| Visualize stages in a process using length-encoded bars. This
| trace can be used to show data in either a part-to-whole
| representation wherein each item appears in a single stage, or
| in a "drop-off" representation wherein each item appears in
| each stage it traversed. See also the "funnelarea" trace type
| for a different approach to visualizing funnel data.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Funnel`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.funnel.Connector` instance
| or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnel.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious` and
| `percentTotal`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnel.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnel.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the funnels. With "v" ("h"),
| the value of the each bar spans along the vertical
| (horizontal). By default funnels are tend to be
| oriented horizontally; unless only "y" array is
| presented or orientation is set to "v". Also regarding
| graphs including only 'horizontal' funnels, "autorange"
| on the "y-axis" are set to "reversed".
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnel.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple funnels, percentages &
| totals are computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `percentInitial`, `percentPrevious`,
| `percentTotal`, `label` and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Funnel
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connector
| The 'connector' property is an instance of Connector
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Connector`
| - A dict of string/value properties that will be passed
| to the Connector constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the fill color.
| line
| :class:`plotly.graph_objects.funnel.connector.L
| ine` instance or dict with compatible
| properties
| visible
| Determines if connector regions and lines are
| drawn.
|
| Returns
| -------
| plotly.graph_objs.funnel.Connector
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total'] joined with '+' characters
| (e.g. 'name+x')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `percentInitial`,
| `percentPrevious` and `percentTotal`. Anything contained in tag
| `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.funnel.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.funnel.marker.Colo
| rBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.funnel.marker.Line
| ` instance or dict with compatible properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.funnel.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the position where the bar is drawn (in position axis
| units). In "group" barmode, traces that set "offset" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'offset' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the funnels. With "v" ("h"), the value
| of the each bar spans along the vertical (horizontal). By
| default funnels are tend to be oriented horizontally; unless
| only "y" array is presented or orientation is set to "v". Also
| regarding graphs including only 'horizontal' funnels,
| "autorange" on the "y-axis" are set to "reversed".
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Outsidetextfont
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.funnel.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the font used for `text`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnel.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnel.Textfont
|
| textinfo
| Determines which trace information appear on the graph. In the
| case of having multiple funnels, percentages & totals are
| computed separately (per trace).
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'percent initial', 'percent previous', 'percent total', 'value'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `percentInitial`, `percentPrevious`, `percentTotal`, `label`
| and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar width (in position axis units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Funnelarea(plotly.basedatatypes.BaseTraceType)
| Funnelarea(arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Funnelarea
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, aspectratio=None, baseratio=None, customdata=None, customdatasrc=None, dlabel=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, scalegroup=None, showlegend=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Funnelarea object
|
| Visualize stages in a process using area-encoded trapezoids.
| This trace can be used to show data in a part-to-whole
| representation similar to a "pie" trace, wherein each item
| appears in a single stage. See also the "funnel" trace type for
| a different approach to visualizing funnel data.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Funnelarea`
| aspectratio
| Sets the ratio between height and width
| baseratio
| Sets the ratio between bottom length and maximum top
| length.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.funnelarea.Domain`
| instance or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.funnelarea.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.funnelarea.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.funnelarea.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.funnelarea.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `text` and
| `percent`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.funnelarea.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Funnelarea
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| aspectratio
| Sets the ratio between height and width
|
| The 'aspectratio' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| baseratio
| Sets the ratio between bottom length and maximum top length.
|
| The 'baseratio' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dlabel
| Sets the label step. See `label0` for more info.
|
| The 'dlabel' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this funnelarea
| trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this funnelarea trace
| .
| x
| Sets the horizontal domain of this funnelarea
| trace (in plot fraction).
| y
| Sets the vertical domain of this funnelarea
| trace (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `label`, `color`,
| `value`, `text` and `percent`. Anything contained in tag
| `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Insidetextfont
|
| label0
| Alternate to `labels`. Builds a numeric set of labels. Use with
| `dlabel` where `label0` is the starting label and `dlabel` the
| step.
|
| The 'label0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| labels
| Sets the sector labels. If `labels` entries are duplicated, we
| sum associated `values` or simply count occurrences if `values`
| is not provided. For other array attributes (including color)
| we use the first non-empty entry among all occurrences of the
| label.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| colors
| Sets the color of each sector. If not
| specified, the default trace color set is used
| to pick the sector colors.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.funnelarea.marker.
| Line` instance or dict with compatible
| properties
| pattern
| Sets the pattern within the marker.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| scalegroup
| If there are multiple funnelareas that should be sized
| according to their totals, link them by providing a non-empty
| group id here shared by every trace in the same group.
|
| The 'scalegroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `textinfo`.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `label`,
| `color`, `value`, `text` and `percent`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.funnelarea.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| font
| Sets the font used for `title`. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| position
| Specifies the location of the `title`. Note
| that the title's position used to be set by the
| now deprecated `titleposition` attribute.
| text
| Sets the title of the chart. If it is empty, no
| title is displayed. Note that before the
| existence of `title.text`, the title's contents
| used to be defined as the `title` attribute
| itself. This behavior has been deprecated.
|
| Returns
| -------
| plotly.graph_objs.funnelarea.Title
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Heatmap(plotly.basedatatypes.BaseTraceType)
| Heatmap(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Heatmap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xgap=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, ygap=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Heatmap object
|
| The data that describes the heatmap value-to-color mapping is
| set in `z`. Data in `z` can either be a 2D list of values
| (ragged or not) or a 1D array of values. In the case where `z`
| is a 2D list, say that `z` has N rows and M columns. Then, by
| default, the resulting heatmap will have N partitions along the
| y axis and M partitions along the x axis. In other words, the
| i-th row/ j-th column cell in `z` is mapped to the i-th
| partition of the y axis (starting from the bottom of the plot)
| and the j-th partition of the x-axis (starting from the left of
| the plot). This behavior can be flipped by using `transpose`.
| Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1)
| elements. If M (N), then the coordinates correspond to the
| center of the heatmap cells and the cells have equal width. If
| M+1 (N+1), then the coordinates correspond to the edges of the
| heatmap cells. In the case where `z` is a 1D list, the x and y
| coordinates must be provided in `x` and `y` respectively to
| form data triplets.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Heatmap`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmap.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in. It is defaulted
| to true if `z` is a one dimensional array and `zsmooth`
| is not false; otherwise it is defaulted to false.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmap.Hoverlabel`
| instance or dict with compatible properties
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data have hover labels associated
| with them.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmap.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textfont
| Sets the text font.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Heatmap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.heatmap
| .colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.heatmap.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of heatmap.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.heatmap.colorbar.T
| itle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| heatmap.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| heatmap.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.heatmap.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data are filled in. It is defaulted to true if `z`
| is a one dimensional array and `zsmooth` is not false;
| otherwise it is defaulted to false.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Hoverlabel
|
| hoverongaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data have hover labels associated with them.
|
| The 'hoverongaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmap.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.heatmap.Textfont
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `x`, `y`,
| `z` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xgap
| Sets the horizontal gap (in pixels) between bricks.
|
| The 'xgap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xtype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'xtype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| ygap
| Sets the vertical gap (in pixels) between bricks.
|
| The 'ygap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ytype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'ytype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', 'best', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Heatmapgl(plotly.basedatatypes.BaseTraceType)
| Heatmapgl(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Heatmapgl
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, showscale=None, stream=None, text=None, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ysrc=None, ytype=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Heatmapgl object
|
| "heatmapgl" trace is deprecated! Please consider switching to
| the "heatmap" or "image" trace types. Alternatively you could
| contribute/sponsor rewriting this trace type based on cartesian
| features and using regl framework. WebGL version of the heatmap
| trace type.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Heatmapgl`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.heatmapgl.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.heatmapgl.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.heatmapgl.Stream` instance
| or dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| transpose
| Transposes the z data.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xtype
| If "array", the heatmap's x coordinates are given by
| "x" (the default behavior when `x` is provided). If
| "scaled", the heatmap's x coordinates are given by "x0"
| and "dx" (the default behavior when `x` is not
| provided).
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| ytype
| If "array", the heatmap's y coordinates are given by
| "y" (the default behavior when `y` is provided) If
| "scaled", the heatmap's y coordinates are given by "y0"
| and "dy" (the default behavior when `y` is not
| provided)
| z
| Sets the z data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Heatmapgl
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.heatmap
| gl.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.heatmapgl.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of heatmapgl.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.heatmapgl.colorbar
| .Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| heatmapgl.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| heatmapgl.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.heatmapgl.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.heatmapgl.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| transpose
| Transposes the z data.
|
| The 'transpose' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xtype
| If "array", the heatmap's x coordinates are given by "x" (the
| default behavior when `x` is provided). If "scaled", the
| heatmap's x coordinates are given by "x0" and "dx" (the default
| behavior when `x` is not provided).
|
| The 'xtype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ytype
| If "array", the heatmap's y coordinates are given by "y" (the
| default behavior when `y` is provided) If "scaled", the
| heatmap's y coordinates are given by "y0" and "dy" (the default
| behavior when `y` is not provided)
|
| The 'ytype' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['array', 'scaled']
|
| Returns
| -------
| Any
|
| z
| Sets the z data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram(plotly.basedatatypes.BaseTraceType)
| Histogram(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Histogram
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cliponaxis=None, constraintext=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, outsidetextfont=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Histogram object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Histogram`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| bingroup
| Set a group of histogram traces which will have
| compatible bin settings. Note that traces on the same
| subplot and with the same "orientation" under `barmode`
| "stack", "relative" and "group" are forced into the
| same bingroup, Using `bingroup`, traces under `barmode`
| "overlay" and on different axes (of the same axis type)
| can have compatible bin settings. Note that histogram
| and histogram2d* trace can share the same `bingroup`
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| cumulative
| :class:`plotly.graph_objects.histogram.Cumulative`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.histogram.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.histogram.ErrorY` instance
| or dict with compatible properties
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `binNumber` Anything contained in tag
| `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selected
| :class:`plotly.graph_objects.histogram.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.histogram.Stream` instance
| or dict with compatible properties
| text
| Sets hover text elements associated with each bar. If a
| single string, the same string appears over all bars.
| If an array of string, the items are mapped in order to
| the this trace's coordinates.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the text font.
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label` and `value`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.histogram.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbins
| :class:`plotly.graph_objects.histogram.XBins` instance
| or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybins
| :class:`plotly.graph_objects.histogram.YBins` instance
| or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Histogram
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobinx` is not needed. However, we accept
| `autobinx: true` or `false` and will update `xbins` accordingly
| before deleting `autobinx` from the trace.
|
| The 'autobinx' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobiny` is not needed. However, we accept
| `autobiny: true` or `false` and will update `ybins` accordingly
| before deleting `autobiny` from the trace.
|
| The 'autobiny' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| bingroup
| Set a group of histogram traces which will have compatible bin
| settings. Note that traces on the same subplot and with the
| same "orientation" under `barmode` "stack", "relative" and
| "group" are forced into the same bingroup, Using `bingroup`,
| traces under `barmode` "overlay" and on different axes (of the
| same axis type) can have compatible bin settings. Note that
| histogram and histogram2d* trace can share the same `bingroup`
|
| The 'bingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| cumulative
| The 'cumulative' property is an instance of Cumulative
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Cumulative`
| - A dict of string/value properties that will be passed
| to the Cumulative constructor
|
| Supported dict properties:
|
| currentbin
| Only applies if cumulative is enabled. Sets
| whether the current bin is included, excluded,
| or has half of its value included in the
| current cumulative value. "include" is the
| default for compatibility with various other
| tools, however it introduces a half-bin bias to
| the results. "exclude" makes the opposite half-
| bin bias, and "half" removes it.
| direction
| Only applies if cumulative is enabled. If
| "increasing" (default) we sum all prior bins,
| so the result increases from left to right. If
| "decreasing" we sum later bins so the result
| decreases from left to right.
| enabled
| If true, display the cumulative distribution by
| summing the binned values. Use the `direction`
| and `centralbin` attributes to tune the
| accumulation method. Note: in this mode, the
| "density" `histnorm` settings behave the same
| as their equivalents without "density": "" and
| "density" both rise to the number of data
| points, and "probability" and *probability
| density* both rise to the number of sample
| points.
|
| Returns
| -------
| plotly.graph_objs.histogram.Cumulative
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.histogram.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.histogram.ErrorY
|
| histfunc
| Specifies the binning function used for this histogram trace.
| If "count", the histogram values are computed by counting the
| number of values lying inside each bin. If "sum", "avg", "min",
| "max", the histogram values are computed using the sum, the
| average, the minimum or the maximum of the values lying inside
| each bin respectively.
|
| The 'histfunc' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['count', 'sum', 'avg', 'min', 'max']
|
| Returns
| -------
| Any
|
| histnorm
| Specifies the type of normalization used for this histogram
| trace. If "", the span of each bar corresponds to the number of
| occurrences (i.e. the number of data points lying inside the
| bins). If "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences with
| respect to the total number of sample points (here, the sum of
| all bin HEIGHTS equals 100% / 1). If "density", the span of
| each bar corresponds to the number of occurrences in a bin
| divided by the size of the bin interval (here, the sum of all
| bin AREAS equals the total number of sample points). If
| *probability density*, the area of each bar corresponds to the
| probability that an event will fall into the corresponding bin
| (here, the sum of all bin AREAS equals 1).
|
| The 'histnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'percent', 'probability', 'density', 'probability
| density']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.histogram.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `binNumber` Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.histogram.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.histogram.marker.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| cornerradius
| Sets the rounding of corners. May be an integer
| number of pixels, or a percentage of bar width
| (as a string ending in %). Defaults to
| `layout.barcornerradius`. In stack or relative
| barmode, the first trace to set cornerradius is
| used for the whole stack.
| line
| :class:`plotly.graph_objects.histogram.marker.L
| ine` instance or dict with compatible
| properties
| opacity
| Sets the opacity of the bars.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.histogram.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| nbinsx
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `xbins.size` is provided.
|
| The 'nbinsx' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| nbinsy
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `ybins.size` is provided.
|
| The 'nbinsy' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the bars. With "v" ("h"), the value of
| the each bar spans along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram.Outsidetextfont
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.histogram.selected
| .Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.histogram.selected
| .Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.histogram.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.histogram.Stream
|
| text
| Sets hover text elements associated with each bar. If a single
| string, the same string appears over all bars. If an array of
| string, the items are mapped in order to the this trace's
| coordinates.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram.Textfont
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `label`
| and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.histogram.unselect
| ed.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.histogram.unselect
| ed.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.histogram.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the sample data to be binned on the x axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbins
| The 'xbins' property is an instance of XBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.XBins`
| - A dict of string/value properties that will be passed
| to the XBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the x axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each x axis bin. Default
| behavior: If `nbinsx` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsx` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1). If multiple non-overlaying histograms
| share a subplot, the first explicit `size` is
| used and all others discarded. If no `size` is
| provided,the sample data from all traces is
| combined to determine `size` as described
| above.
| start
| Sets the starting value for the x axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5. If multiple non-
| overlaying histograms share a subplot, the
| first explicit `start` is used exactly and all
| others are shifted down (if necessary) to
| differ from that one by an integer number of
| bins.
|
| Returns
| -------
| plotly.graph_objs.histogram.XBins
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the sample data to be binned on the y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybins
| The 'ybins' property is an instance of YBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram.YBins`
| - A dict of string/value properties that will be passed
| to the YBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the y axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each y axis bin. Default
| behavior: If `nbinsy` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsy` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1). If multiple non-overlaying histograms
| share a subplot, the first explicit `size` is
| used and all others discarded. If no `size` is
| provided,the sample data from all traces is
| combined to determine `size` as described
| above.
| start
| Sets the starting value for the y axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5. If multiple non-
| overlaying histograms share a subplot, the
| first explicit `start` is used exactly and all
| others are shifted down (if necessary) to
| differ from that one by an integer number of
| bins.
|
| Returns
| -------
| plotly.graph_objs.histogram.YBins
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram2d(plotly.basedatatypes.BaseTraceType)
| Histogram2d(arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Histogram2d
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xgap=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, ygap=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Histogram2d object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Histogram2d`
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2d.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2d.Legendgrouptit
| le` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.histogram2d.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2d.Stream`
| instance or dict with compatible properties
| textfont
| Sets the text font.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z`
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2d.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xgap
| Sets the horizontal gap (in pixels) between bricks.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2d.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| ygap
| Sets the vertical gap (in pixels) between bricks.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Histogram2d
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobinx` is not needed. However, we accept
| `autobinx: true` or `false` and will update `xbins` accordingly
| before deleting `autobinx` from the trace.
|
| The 'autobinx' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobiny` is not needed. However, we accept
| `autobiny: true` or `false` and will update `ybins` accordingly
| before deleting `autobiny` from the trace.
|
| The 'autobiny' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For example,
| setting a `bingroup` of 1 on two histogram2d traces will make
| them their x-bins and y-bins match separately.
|
| The 'bingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.histogr
| am2d.colorbar.Tickformatstop` instances or
| dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.histogram2d.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of
| histogram2d.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.histogram2d.colorb
| ar.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| histogram2d.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| histogram2d.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| histfunc
| Specifies the binning function used for this histogram trace.
| If "count", the histogram values are computed by counting the
| number of values lying inside each bin. If "sum", "avg", "min",
| "max", the histogram values are computed using the sum, the
| average, the minimum or the maximum of the values lying inside
| each bin respectively.
|
| The 'histfunc' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['count', 'sum', 'avg', 'min', 'max']
|
| Returns
| -------
| Any
|
| histnorm
| Specifies the type of normalization used for this histogram
| trace. If "", the span of each bar corresponds to the number of
| occurrences (i.e. the number of data points lying inside the
| bins). If "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences with
| respect to the total number of sample points (here, the sum of
| all bin HEIGHTS equals 100% / 1). If "density", the span of
| each bar corresponds to the number of occurrences in a bin
| divided by the size of the bin interval (here, the sum of all
| bin AREAS equals the total number of sample points). If
| *probability density*, the area of each bar corresponds to the
| probability that an event will fall into the corresponding bin
| (here, the sum of all bin AREAS equals 1).
|
| The 'histnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'percent', 'probability', 'density', 'probability
| density']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `z` Anything contained
| in tag `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| color
| Sets the aggregation data.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| nbinsx
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `xbins.size` is provided.
|
| The 'nbinsx' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| nbinsy
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `ybins.size` is provided.
|
| The 'nbinsy' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Stream
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.Textfont
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variable `z`
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the sample data to be binned on the x axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbingroup
| Set a group of histogram traces which will have compatible
| x-bin settings. Using `xbingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible x-bin settings. Note that the same `xbingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'xbingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xbins
| The 'xbins' property is an instance of XBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.XBins`
| - A dict of string/value properties that will be passed
| to the XBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the x axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each x axis bin. Default
| behavior: If `nbinsx` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsx` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the x axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.XBins
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xgap
| Sets the horizontal gap (in pixels) between bricks.
|
| The 'xgap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the sample data to be binned on the y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybingroup
| Set a group of histogram traces which will have compatible
| y-bin settings. Using `ybingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible y-bin settings. Note that the same `ybingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'ybingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ybins
| The 'ybins' property is an instance of YBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2d.YBins`
| - A dict of string/value properties that will be passed
| to the YBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the y axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each y axis bin. Default
| behavior: If `nbinsy` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsy` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the y axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2d.YBins
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| ygap
| Sets the vertical gap (in pixels) between bricks.
|
| The 'ygap' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the aggregation data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsmooth
| Picks a smoothing algorithm use to smooth `z` data.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', 'best', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram2dContour(plotly.basedatatypes.BaseTraceType)
| Histogram2dContour(arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Histogram2dContour
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autobinx=None, autobiny=None, autocolorscale=None, autocontour=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, textfont=None, texttemplate=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbingroup=None, xbins=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, yaxis=None, ybingroup=None, ybins=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)
| Construct a new Histogram2dContour object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Histogram2dContour`
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobinx` is not needed.
| However, we accept `autobinx: true` or `false` and will
| update `xbins` accordingly before deleting `autobinx`
| from the trace.
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-
| determined separately and `autobiny` is not needed.
| However, we accept `autobiny: true` or `false` and will
| update `ybins` accordingly before deleting `autobiny`
| from the trace.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| autocontour
| Determines whether or not the contour level attributes
| are picked by an algorithm. If True, the number of
| contour levels can be set in `ncontours`. If False, set
| the contour level attributes in `contours`.
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For
| example, setting a `bingroup` of 1 on two histogram2d
| traces will make them their x-bins and y-bins match
| separately.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.histogram2dcontour.ColorBa
| r` instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contours
| :class:`plotly.graph_objects.histogram2dcontour.Contour
| s` instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| histfunc
| Specifies the binning function used for this histogram
| trace. If "count", the histogram values are computed by
| counting the number of values lying inside each bin. If
| "sum", "avg", "min", "max", the histogram values are
| computed using the sum, the average, the minimum or the
| maximum of the values lying inside each bin
| respectively.
| histnorm
| Specifies the type of normalization used for this
| histogram trace. If "", the span of each bar
| corresponds to the number of occurrences (i.e. the
| number of data points lying inside the bins). If
| "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences
| with respect to the total number of sample points
| (here, the sum of all bin HEIGHTS equals 100% / 1). If
| "density", the span of each bar corresponds to the
| number of occurrences in a bin divided by the size of
| the bin interval (here, the sum of all bin AREAS equals
| the total number of sample points). If *probability
| density*, the area of each bar corresponds to the
| probability that an event will fall into the
| corresponding bin (here, the sum of all bin AREAS
| equals 1).
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.histogram2dcontour.Hoverla
| bel` instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variable `z` Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.histogram2dcontour.Legendg
| rouptitle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.histogram2dcontour.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.histogram2dcontour.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| nbinsx
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `xbins.size` is provided.
| nbinsy
| Specifies the maximum number of desired bins. This
| value will be used in an algorithm that will decide the
| optimal bin size such that the histogram best
| visualizes the distribution of the data. Ignored if
| `ybins.size` is provided.
| ncontours
| Sets the maximum number of contour levels. The actual
| number of contours will be chosen automatically to be
| less than or equal to the value of `ncontours`. Has an
| effect only if `autocontour` is True or if
| `contours.size` is missing.
| opacity
| Sets the opacity of the trace.
| reversescale
| Reverses the color mapping if true. If true, `zmin`
| will correspond to the last color in the array and
| `zmax` will correspond to the first color.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.histogram2dcontour.Stream`
| instance or dict with compatible properties
| textfont
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Sets the text font.
| texttemplate
| For this trace it only has an effect if `coloring` is
| set to "heatmap". Template string used for rendering
| the information text that appear on points. Note that
| this will override `textinfo`. Variables are inserted
| using %{variable}, for example "y: %{y}". Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `x`, `y`, `z` and `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the sample data to be binned on the x axis.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbingroup
| Set a group of histogram traces which will have
| compatible x-bin settings. Using `xbingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible x-bin settings.
| Note that the same `xbingroup` value can be used to set
| (1D) histogram `bingroup`
| xbins
| :class:`plotly.graph_objects.histogram2dcontour.XBins`
| instance or dict with compatible properties
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the sample data to be binned on the y axis.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybingroup
| Set a group of histogram traces which will have
| compatible y-bin settings. Using `ybingroup`,
| histogram2d and histogram2dcontour traces (on axes of
| the same axis type) can have compatible y-bin settings.
| Note that the same `ybingroup` value can be used to set
| (1D) histogram `bingroup`
| ybins
| :class:`plotly.graph_objects.histogram2dcontour.YBins`
| instance or dict with compatible properties
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the aggregation data.
| zauto
| Determines whether or not the color domain is computed
| with respect to the input data (here in `z`) or the
| bounds set in `zmin` and `zmax` Defaults to `false`
| when `zmin` and `zmax` are set by the user.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| zmax
| Sets the upper bound of the color domain. Value should
| have the same units as in `z` and if set, `zmin` must
| be set as well.
| zmid
| Sets the mid-point of the color domain by scaling
| `zmin` and/or `zmax` to be equidistant to this point.
| Value should have the same units as in `z`. Has no
| effect when `zauto` is `false`.
| zmin
| Sets the lower bound of the color domain. Value should
| have the same units as in `z` and if set, `zmax` must
| be set as well.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Histogram2dContour
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autobinx
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobinx` is not needed. However, we accept
| `autobinx: true` or `false` and will update `xbins` accordingly
| before deleting `autobinx` from the trace.
|
| The 'autobinx' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autobiny
| Obsolete: since v1.42 each bin attribute is auto-determined
| separately and `autobiny` is not needed. However, we accept
| `autobiny: true` or `false` and will update `ybins` accordingly
| before deleting `autobiny` from the trace.
|
| The 'autobiny' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autocontour
| Determines whether or not the contour level attributes are
| picked by an algorithm. If True, the number of contour levels
| can be set in `ncontours`. If False, set the contour level
| attributes in `contours`.
|
| The 'autocontour' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| bingroup
| Set the `xbingroup` and `ybingroup` default prefix For example,
| setting a `bingroup` of 1 on two histogram2d traces will make
| them their x-bins and y-bins match separately.
|
| The 'bingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.histogr
| am2dcontour.colorbar.Tickformatstop` instances
| or dicts with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.histogram2dcontour.colorbar.tickformatstopdef
| aults), sets the default property values to use
| for elements of
| histogram2dcontour.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.histogram2dcontour
| .colorbar.Title` instance or dict with
| compatible properties
| titlefont
| Deprecated: Please use
| histogram2dcontour.colorbar.title.font instead.
| Sets this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| histogram2dcontour.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `zmin` and `zmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| coloring
| Determines the coloring method showing the
| contour values. If "fill", coloring is done
| evenly between each contour level If "heatmap",
| a heatmap gradient coloring is applied between
| each contour level. If "lines", coloring is
| done on the contour lines. If "none", no
| coloring is applied on this trace.
| end
| Sets the end contour level value. Must be more
| than `contours.start`
| labelfont
| Sets the font used for labeling the contour
| levels. The default color comes from the lines,
| if shown. The default family and size come from
| `layout.font`.
| labelformat
| Sets the contour label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| operation
| Sets the constraint operation. "=" keeps
| regions equal to `value` "<" and "<=" keep
| regions less than `value` ">" and ">=" keep
| regions greater than `value` "[]", "()", "[)",
| and "(]" keep regions inside `value[0]` to
| `value[1]` "][", ")(", "](", ")[" keep regions
| outside `value[0]` to value[1]` Open vs. closed
| intervals make no difference to constraint
| display, but all versions are allowed for
| consistency with filter transforms.
| showlabels
| Determines whether to label the contour lines
| with their values.
| showlines
| Determines whether or not the contour lines are
| drawn. Has an effect only if
| `contours.coloring` is set to "fill".
| size
| Sets the step between each contour level. Must
| be positive.
| start
| Sets the starting contour level value. Must be
| less than `contours.end`
| type
| If `levels`, the data is represented as a
| contour plot with multiple levels displayed. If
| `constraint`, the data is represented as
| constraints with the invalid region shaded as
| specified by the `operation` and `value`
| parameters.
| value
| Sets the value or values of the constraint
| boundary. When `operation` is set to one of the
| comparison values (=,<,>=,>,<=) "value" is
| expected to be a number. When `operation` is
| set to one of the interval values
| ([],(),[),(],][,)(,](,)[) "value" is expected
| to be an array of two numbers where the first
| is the lower bound and the second is the upper
| bound.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| histfunc
| Specifies the binning function used for this histogram trace.
| If "count", the histogram values are computed by counting the
| number of values lying inside each bin. If "sum", "avg", "min",
| "max", the histogram values are computed using the sum, the
| average, the minimum or the maximum of the values lying inside
| each bin respectively.
|
| The 'histfunc' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['count', 'sum', 'avg', 'min', 'max']
|
| Returns
| -------
| Any
|
| histnorm
| Specifies the type of normalization used for this histogram
| trace. If "", the span of each bar corresponds to the number of
| occurrences (i.e. the number of data points lying inside the
| bins). If "percent" / "probability", the span of each bar
| corresponds to the percentage / fraction of occurrences with
| respect to the total number of sample points (here, the sum of
| all bin HEIGHTS equals 100% / 1). If "density", the span of
| each bar corresponds to the number of occurrences in a bin
| divided by the size of the bin interval (here, the sum of all
| bin AREAS equals the total number of sample points). If
| *probability density*, the area of each bar corresponds to the
| probability that an event will fall into the corresponding bin
| (here, the sum of all bin AREAS equals 1).
|
| The 'histnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'percent', 'probability', 'density', 'probability
| density']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variable `z` Anything contained
| in tag `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour level. Has no
| effect if `contours.coloring` is set to
| "lines".
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| smoothing
| Sets the amount of smoothing for the contour
| lines, where 0 corresponds to no smoothing.
| width
| Sets the contour line width in (in px)
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| color
| Sets the aggregation data.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| nbinsx
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `xbins.size` is provided.
|
| The 'nbinsx' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| nbinsy
| Specifies the maximum number of desired bins. This value will
| be used in an algorithm that will decide the optimal bin size
| such that the histogram best visualizes the distribution of the
| data. Ignored if `ybins.size` is provided.
|
| The 'nbinsy' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| ncontours
| Sets the maximum number of contour levels. The actual number of
| contours will be chosen automatically to be less than or equal
| to the value of `ncontours`. Has an effect only if
| `autocontour` is True or if `contours.size` is missing.
|
| The 'ncontours' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [1, 9223372036854775807]
|
| Returns
| -------
| int
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `zmin` will
| correspond to the last color in the array and `zmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Stream
|
| textfont
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.Textfont
|
| texttemplate
| For this trace it only has an effect if `coloring` is set to
| "heatmap". Template string used for rendering the information
| text that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable}, for
| example "y: %{y}". Numbers are formatted using d3-format's
| syntax %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `x`, `y`,
| `z` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the sample data to be binned on the x axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbingroup
| Set a group of histogram traces which will have compatible
| x-bin settings. Using `xbingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible x-bin settings. Note that the same `xbingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'xbingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xbins
| The 'xbins' property is an instance of XBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.XBins`
| - A dict of string/value properties that will be passed
| to the XBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the x axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each x axis bin. Default
| behavior: If `nbinsx` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsx` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the x axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.XBins
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the sample data to be binned on the y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybingroup
| Set a group of histogram traces which will have compatible
| y-bin settings. Using `ybingroup`, histogram2d and
| histogram2dcontour traces (on axes of the same axis type) can
| have compatible y-bin settings. Note that the same `ybingroup`
| value can be used to set (1D) histogram `bingroup`
|
| The 'ybingroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ybins
| The 'ybins' property is an instance of YBins
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.histogram2dcontour.YBins`
| - A dict of string/value properties that will be passed
| to the YBins constructor
|
| Supported dict properties:
|
| end
| Sets the end value for the y axis bins. The
| last bin may not end exactly at this value, we
| increment the bin edge by `size` from `start`
| until we reach or exceed `end`. Defaults to the
| maximum data value. Like `start`, for dates use
| a date string, and for category data `end` is
| based on the category serial numbers.
| size
| Sets the size of each y axis bin. Default
| behavior: If `nbinsy` is 0 or omitted, we
| choose a nice round bin size such that the
| number of bins is about the same as the typical
| number of samples in each bin. If `nbinsy` is
| provided, we choose a nice round bin size
| giving no more than that many bins. For date
| data, use milliseconds or "M<n>" for months, as
| in `axis.dtick`. For category data, the number
| of categories to bin together (always defaults
| to 1).
| start
| Sets the starting value for the y axis bins.
| Defaults to the minimum data value, shifted
| down if necessary to make nice round values and
| to remove ambiguous bin edges. For example, if
| most of the data is integers we shift the bin
| edges 0.5 down, so a `size` of 5 would have a
| default `start` of -0.5, so it is clear that
| 0-4 are in the first bin, 5-9 in the second,
| but continuous data gets a start of 0 and bins
| [0,5), [5,10) etc. Dates behave similarly, and
| `start` should be a date string. For category
| data, `start` is based on the category serial
| numbers, and defaults to -0.5.
|
| Returns
| -------
| plotly.graph_objs.histogram2dcontour.YBins
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the aggregation data.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zauto
| Determines whether or not the color domain is computed with
| respect to the input data (here in `z`) or the bounds set in
| `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
| are set by the user.
|
| The 'zauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zmax
| Sets the upper bound of the color domain. Value should have the
| same units as in `z` and if set, `zmin` must be set as well.
|
| The 'zmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmid
| Sets the mid-point of the color domain by scaling `zmin` and/or
| `zmax` to be equidistant to this point. Value should have the
| same units as in `z`. Has no effect when `zauto` is `false`.
|
| The 'zmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zmin
| Sets the lower bound of the color domain. Value should have the
| same units as in `z` and if set, `zmax` must be set as well.
|
| The 'zmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Histogram2dcontour(builtins.dict)
| Histogram2dcontour(*args, **kwargs)
|
| plotly.graph_objs.Histogram2dcontour is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Histogram2dContour
|
| Method resolution order:
| Histogram2dcontour
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Histogram2dcontour is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Histogram2dContour
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Icicle(plotly.basedatatypes.BaseTraceType)
| Icicle(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Icicle
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Icicle object
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The icicle sectors are determined
| by the entries in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Icicle`
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.icicle.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.icicle.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.icicle.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.icicle.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.icicle.Marker` instance or
| dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.icicle.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.icicle.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.icicle.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.icicle.Tiling` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Icicle
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| branchvalues
| Determines how the items in `values` are summed. When set to
| "total", items in `values` are taken to be value of all its
| descendants. When set to "remainder", items in `values`
| corresponding to the root and the branches sectors are taken to
| be the extra part not part of the sum of the values at their
| leaves.
|
| The 'branchvalues' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['remainder', 'total']
|
| Returns
| -------
| Any
|
| count
| Determines default for `values` when it is not provided, by
| inferring a 1 for each of the "leaves" and/or "branches",
| otherwise 0.
|
| The 'count' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['branches', 'leaves'] joined with '+' characters
| (e.g. 'branches+leaves')
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this icicle trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this icicle trace .
| x
| Sets the horizontal domain of this icicle trace
| (in plot fraction).
| y
| Sets the vertical domain of this icicle trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.icicle.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `currentPath`, `root`,
| `entry`, `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Insidetextfont
|
| labels
| Sets the labels of each of the sectors.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| leaf
| The 'leaf' property is an instance of Leaf
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Leaf`
| - A dict of string/value properties that will be passed
| to the Leaf constructor
|
| Supported dict properties:
|
| opacity
| Sets the opacity of the leaves. With colorscale
| it is defaulted to 1; otherwise it is defaulted
| to 0.7
|
| Returns
| -------
| plotly.graph_objs.icicle.Leaf
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.icicle.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| level
| Sets the level from which this trace hierarchy is rendered. Set
| `level` to `''` to start from the root node in the hierarchy.
| Must be an "id" if `ids` is filled in, otherwise plotly
| attempts to find a matching item in `labels`.
|
| The 'level' property accepts values of any type
|
| Returns
| -------
| Any
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if colors is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| colors) or the bounds set in `marker.cmin` and
| `marker.cmax` Has an effect only if colors is
| set to a numerical array. Defaults to `false`
| when `marker.cmin` and `marker.cmax` are set by
| the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmin` must be set as
| well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if colors is set to a numerical array.
| Value should have the same units as colors. Has
| no effect when `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmax` must be set as
| well.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.icicle.marker.Colo
| rBar` instance or dict with compatible
| properties
| colors
| Sets the color of each sector of this trace. If
| not specified, the default trace color set is
| used to pick the sector colors.
| colorscale
| Sets the colorscale. Has an effect only if
| colors is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.icicle.marker.Line
| ` instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if colors is set to a numerical
| array. If true, `marker.cmin` will correspond
| to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| colors is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.icicle.Marker
|
| maxdepth
| Sets the number of rendered sectors from any given `level`. Set
| `maxdepth` to "-1" to render all the levels in the hierarchy.
|
| The 'maxdepth' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
| This option refers to the root of the hierarchy presented on
| top left corner of a treemap graph. Please note that if a
| hierarchy has multiple root nodes, this option won't have any
| effect and `insidetextfont` would be used.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Outsidetextfont
|
| parents
| Sets the parent sectors for each of the sectors. Empty string
| items '' are understood to reference the root node in the
| hierarchy. If `ids` is filled, `parents` items are understood
| to be "ids" themselves. When `ids` is not set, plotly attempts
| to find matching items in `labels`, but beware they must be
| unique.
|
| The 'parents' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| parentssrc
| Sets the source reference on Chart Studio Cloud for `parents`.
|
| The 'parentssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| pathbar
| The 'pathbar' property is an instance of Pathbar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Pathbar`
| - A dict of string/value properties that will be passed
| to the Pathbar constructor
|
| Supported dict properties:
|
| edgeshape
| Determines which shape is used for edges
| between `barpath` labels.
| side
| Determines on which side of the the treemap the
| `pathbar` should be presented.
| textfont
| Sets the font used inside `pathbar`.
| thickness
| Sets the thickness of `pathbar` (in px). If not
| specified the `pathbar.textfont.size` is used
| with 3 pixles extra padding on each side.
| visible
| Determines if the path bar is drawn i.e.
| outside the trace `domain` and with one pixel
| gap.
|
| Returns
| -------
| plotly.graph_objs.icicle.Pathbar
|
| root
| The 'root' property is an instance of Root
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Root`
| - A dict of string/value properties that will be passed
| to the Root constructor
|
| Supported dict properties:
|
| color
| sets the color of the root node for a
| sunburst/treemap/icicle trace. this has no
| effect when a colorscale is used to set the
| markers.
|
| Returns
| -------
| plotly.graph_objs.icicle.Root
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.icicle.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.icicle.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Sets the positions of the `text` elements.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
| `percentParent`, `label` and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| tiling
| The 'tiling' property is an instance of Tiling
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.icicle.Tiling`
| - A dict of string/value properties that will be passed
| to the Tiling constructor
|
| Supported dict properties:
|
| flip
| Determines if the positions obtained from
| solver are flipped on each axis.
| orientation
| When set in conjunction with `tiling.flip`,
| determines on which side the root nodes are
| drawn in the chart. If `tiling.orientation` is
| "v" and `tiling.flip` is "", the root nodes
| appear at the top. If `tiling.orientation` is
| "v" and `tiling.flip` is "y", the root nodes
| appear at the bottom. If `tiling.orientation`
| is "h" and `tiling.flip` is "", the root nodes
| appear at the left. If `tiling.orientation` is
| "h" and `tiling.flip` is "x", the root nodes
| appear at the right.
| pad
| Sets the inner padding (in px).
|
| Returns
| -------
| plotly.graph_objs.icicle.Tiling
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values associated with each of the sectors. Use with
| `branchvalues` to determine how the values are summed.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Image(plotly.basedatatypes.BaseTraceType)
| Image(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Image
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, opacity=None, source=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zorder=None, zsmooth=None, zsrc=None, **kwargs)
| Construct a new Image object
|
| Display an image, i.e. data on a 2D regular raster. By default,
| when an image is displayed in a subplot, its y axis will be
| reversed (ie. `autorange: 'reversed'`), constrained to the
| domain (ie. `constrain: 'domain'`) and it will have the same
| scale as its x axis (ie. `scaleanchor: 'x,`) in order for
| pixels to be rendered as squares.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Image`
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified,
| this attribute will be set to `rgba256` otherwise it
| defaults to `rgb`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Set the pixel's horizontal size.
| dy
| Set the pixel's vertical size
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.image.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `z`, `color` and `colormodel`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.image.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| source
| Specifies the data URI of the image to be visualized.
| The URI consists of "data:image/[<media
| subtype>][;base64],<data>"
| stream
| :class:`plotly.graph_objects.image.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each z value.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x0
| Set the image's x position. The left edge of the image
| (or the right edge if the x axis is reversed or dx is
| negative) will be found at xmin=x0-dx/2
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| y0
| Set the image's y position. The top edge of the image
| (or the bottom edge if the y axis is NOT reversed or if
| dy is negative) will be found at ymin=y0-dy/2. By
| default when an image trace is included, the y axis
| will be reversed so that the image is right-side-up,
| but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis
| range.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| z
| A 2-dimensional array in which each element is an array
| of 3 or 4 numbers representing a color.
| zmax
| Array defining the higher bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [255,
| 255, 255]. For the `rgba` colormodel, it is [255, 255,
| 255, 1]. For the `rgba256` colormodel, it is [255, 255,
| 255, 255]. For the `hsl` colormodel, it is [360, 100,
| 100]. For the `hsla` colormodel, it is [360, 100, 100,
| 1].
| zmin
| Array defining the lower bound for each color
| component. Note that the default value will depend on
| the colormodel. For the `rgb` colormodel, it is [0, 0,
| 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For
| the `rgba256` colormodel, it is [0, 0, 0, 0]. For the
| `hsl` colormodel, it is [0, 0, 0]. For the `hsla`
| colormodel, it is [0, 0, 0, 0].
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data.
| This only applies for image traces that use the
| `source` attribute.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Image
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| colormodel
| Color model used to map the numerical color components
| described in `z` into colors. If `source` is specified, this
| attribute will be set to `rgba256` otherwise it defaults to
| `rgb`.
|
| The 'colormodel' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Set the pixel's horizontal size.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Set the pixel's vertical size
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'color', 'name', 'text'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.image.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.image.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `z`, `color` and
| `colormodel`. Anything contained in tag `<extra>` is displayed
| in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.image.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.image.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| source
| Specifies the data URI of the image to be visualized. The URI
| consists of "data:image/[<media subtype>][;base64],<data>"
|
| The 'source' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.image.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.image.Stream
|
| text
| Sets the text elements associated with each z value.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x0
| Set the image's x position. The left edge of the image (or the
| right edge if the x axis is reversed or dx is negative) will be
| found at xmin=x0-dx/2
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| y0
| Set the image's y position. The top edge of the image (or the
| bottom edge if the y axis is NOT reversed or if dy is negative)
| will be found at ymin=y0-dy/2. By default when an image trace
| is included, the y axis will be reversed so that the image is
| right-side-up, but you can disable this by setting
| yaxis.autorange=true or by providing an explicit y axis range.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| z
| A 2-dimensional array in which each element is an array of 3 or
| 4 numbers representing a color.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zmax
| Array defining the higher bound for each color component. Note
| that the default value will depend on the colormodel. For the
| `rgb` colormodel, it is [255, 255, 255]. For the `rgba`
| colormodel, it is [255, 255, 255, 1]. For the `rgba256`
| colormodel, it is [255, 255, 255, 255]. For the `hsl`
| colormodel, it is [360, 100, 100]. For the `hsla` colormodel,
| it is [360, 100, 100, 1].
|
| The 'zmax' property is an info array that may be specified as:
|
| * a list or tuple of 4 elements where:
| (0) The 'zmax[0]' property is a number and may be specified as:
| - An int or float
| (1) The 'zmax[1]' property is a number and may be specified as:
| - An int or float
| (2) The 'zmax[2]' property is a number and may be specified as:
| - An int or float
| (3) The 'zmax[3]' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| list
|
| zmin
| Array defining the lower bound for each color component. Note
| that the default value will depend on the colormodel. For the
| `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel,
| it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0,
| 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the
| `hsla` colormodel, it is [0, 0, 0, 0].
|
| The 'zmin' property is an info array that may be specified as:
|
| * a list or tuple of 4 elements where:
| (0) The 'zmin[0]' property is a number and may be specified as:
| - An int or float
| (1) The 'zmin[1]' property is a number and may be specified as:
| - An int or float
| (2) The 'zmin[2]' property is a number and may be specified as:
| - An int or float
| (3) The 'zmin[3]' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| list
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| zsmooth
| Picks a smoothing algorithm used to smooth `z` data. This only
| applies for image traces that use the `source` attribute.
|
| The 'zsmooth' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['fast', False]
|
| Returns
| -------
| Any
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Indicator(plotly.basedatatypes.BaseTraceType)
| Indicator(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)
|
| Method resolution order:
| Indicator
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)
| Construct a new Indicator object
|
| An indicator is used to visualize a single `value` along with
| some contextual information such as `steps` or a `threshold`,
| using a combination of three visual elements: a number, a
| delta, and/or a gauge. Deltas are taken with respect to a
| `reference`. Gauges can be either angular or bullet (aka
| linear) gauges.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Indicator`
| align
| Sets the horizontal alignment of the `text` within the
| box. Note that this attribute has no effect if an
| angular gauge is displayed: in this case, it is always
| centered
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delta
| :class:`plotly.graph_objects.indicator.Delta` instance
| or dict with compatible properties
| domain
| :class:`plotly.graph_objects.indicator.Domain` instance
| or dict with compatible properties
| gauge
| The gauge of the Indicator plot.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.indicator.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines how the value is displayed on the graph.
| `number` displays the value numerically in text.
| `delta` displays the difference to a reference value in
| text. Finally, `gauge` displays the value graphically
| on an axis.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| number
| :class:`plotly.graph_objects.indicator.Number` instance
| or dict with compatible properties
| stream
| :class:`plotly.graph_objects.indicator.Stream` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.indicator.Title` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the number to be displayed.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Indicator
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| align
| Sets the horizontal alignment of the `text` within the box.
| Note that this attribute has no effect if an angular gauge is
| displayed: in this case, it is always centered
|
| The 'align' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['left', 'center', 'right']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| delta
| The 'delta' property is an instance of Delta
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Delta`
| - A dict of string/value properties that will be passed
| to the Delta constructor
|
| Supported dict properties:
|
| decreasing
| :class:`plotly.graph_objects.indicator.delta.De
| creasing` instance or dict with compatible
| properties
| font
| Set the font used to display the delta
| increasing
| :class:`plotly.graph_objects.indicator.delta.In
| creasing` instance or dict with compatible
| properties
| position
| Sets the position of delta with respect to the
| number.
| prefix
| Sets a prefix appearing before the delta.
| reference
| Sets the reference value to compute the delta.
| By default, it is set to the current value.
| relative
| Show relative change
| suffix
| Sets a suffix appearing next to the delta.
| valueformat
| Sets the value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
|
| Returns
| -------
| plotly.graph_objs.indicator.Delta
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this indicator
| trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this indicator trace .
| x
| Sets the horizontal domain of this indicator
| trace (in plot fraction).
| y
| Sets the vertical domain of this indicator
| trace (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.indicator.Domain
|
| gauge
| The gauge of the Indicator plot.
|
| The 'gauge' property is an instance of Gauge
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Gauge`
| - A dict of string/value properties that will be passed
| to the Gauge constructor
|
| Supported dict properties:
|
| axis
| :class:`plotly.graph_objects.indicator.gauge.Ax
| is` instance or dict with compatible properties
| bar
| Set the appearance of the gauge's value
| bgcolor
| Sets the gauge background color.
| bordercolor
| Sets the color of the border enclosing the
| gauge.
| borderwidth
| Sets the width (in px) of the border enclosing
| the gauge.
| shape
| Set the shape of the gauge
| steps
| A tuple of :class:`plotly.graph_objects.indicat
| or.gauge.Step` instances or dicts with
| compatible properties
| stepdefaults
| When used in a template (as layout.template.dat
| a.indicator.gauge.stepdefaults), sets the
| default property values to use for elements of
| indicator.gauge.steps
| threshold
| :class:`plotly.graph_objects.indicator.gauge.Th
| reshold` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.indicator.Gauge
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.indicator.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines how the value is displayed on the graph. `number`
| displays the value numerically in text. `delta` displays the
| difference to a reference value in text. Finally, `gauge`
| displays the value graphically on an axis.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['number', 'delta', 'gauge'] joined with '+' characters
| (e.g. 'number+delta')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| number
| The 'number' property is an instance of Number
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Number`
| - A dict of string/value properties that will be passed
| to the Number constructor
|
| Supported dict properties:
|
| font
| Set the font used to display main number
| prefix
| Sets a prefix appearing before the number.
| suffix
| Sets a suffix appearing next to the number.
| valueformat
| Sets the value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
|
| Returns
| -------
| plotly.graph_objs.indicator.Number
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.indicator.Stream
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.indicator.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the title. It
| defaults to `center` except for bullet charts
| for which it defaults to right.
| font
| Set the font used to display the title
| text
| Sets the title of this indicator.
|
| Returns
| -------
| plotly.graph_objs.indicator.Title
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| value
| Sets the number to be displayed.
|
| The 'value' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Isosurface(plotly.basedatatypes.BaseTraceType)
| Isosurface(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Isosurface
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Isosurface object
|
| Draws isosurfaces between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Isosurface`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.isosurface.Caps` instance
| or dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.isosurface.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.isosurface.Contour`
| instance or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.isosurface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.isosurface.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.isosurface.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.isosurface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.isosurface.Slices`
| instance or dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.isosurface.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.isosurface.Stream`
| instance or dict with compatible properties
| surface
| :class:`plotly.graph_objects.isosurface.Surface`
| instance or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Isosurface
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| caps
| The 'caps' property is an instance of Caps
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Caps`
| - A dict of string/value properties that will be passed
| to the Caps constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.isosurface.caps.X`
| instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.isosurface.caps.Y`
| instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.isosurface.caps.Z`
| instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.isosurface.Caps
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here `value`) or the bounds set in
| `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as `value` and if set, `cmin` must be set as well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as `value`. Has no effect when `cauto` is `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as `value` and if set, `cmax` must be set as well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.isosurf
| ace.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.isosurface.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of isosurface.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.isosurface.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| isosurface.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| isosurface.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.isosurface.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contour
| The 'contour' property is an instance of Contour
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Contour`
| - A dict of string/value properties that will be passed
| to the Contour constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour lines.
| show
| Sets whether or not dynamic contours are shown
| on hover
| width
| Sets the width of the contour lines.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Contour
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| flatshading
| Determines whether or not normal smoothing is applied to the
| meshes, creating meshes with an angular, low-poly look via flat
| reflections.
|
| The 'flatshading' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| isomax
| Sets the maximum boundary for iso-surface plot.
|
| The 'isomax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| isomin
| Sets the minimum boundary for iso-surface plot.
|
| The 'isomin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| slices
| The 'slices' property is an instance of Slices
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Slices`
| - A dict of string/value properties that will be passed
| to the Slices constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.isosurface.slices.
| X` instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.isosurface.slices.
| Y` instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.isosurface.slices.
| Z` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.isosurface.Slices
|
| spaceframe
| The 'spaceframe' property is an instance of Spaceframe
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Spaceframe`
| - A dict of string/value properties that will be passed
| to the Spaceframe constructor
|
| Supported dict properties:
|
| fill
| Sets the fill ratio of the `spaceframe`
| elements. The default fill value is 0.15
| meaning that only 15% of the area of every
| faces of tetras would be shaded. Applying a
| greater `fill` ratio would allow the creation
| of stronger elements or could be sued to have
| entirely closed areas (in case of using 1).
| show
| Displays/hides tetrahedron shapes between
| minimum and maximum iso-values. Often useful
| when either caps or surfaces are disabled or
| filled with values less than 1.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Spaceframe
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Stream
|
| surface
| The 'surface' property is an instance of Surface
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.isosurface.Surface`
| - A dict of string/value properties that will be passed
| to the Surface constructor
|
| Supported dict properties:
|
| count
| Sets the number of iso-surfaces between minimum
| and maximum iso-values. By default this value
| is 2 meaning that only minimum and maximum
| surfaces would be drawn.
| fill
| Sets the fill ratio of the iso-surface. The
| default fill value of the surface is 1 meaning
| that they are entirely shaded. On the other
| hand Applying a `fill` ratio less than one
| would allow the creation of openings parallel
| to the edges.
| pattern
| Sets the surface pattern of the iso-surface 3-D
| sections. The default pattern of the surface is
| `all` meaning that the rest of surface elements
| would be shaded. The check options (either 1 or
| 2) could be used to draw half of the squares on
| the surface. Using various combinations of
| capital `A`, `B`, `C`, `D` and `E` may also be
| used to reduce the number of triangles on the
| iso-surfaces and creating other patterns of
| interest.
| show
| Hides/displays surfaces between minimum and
| maximum iso-values.
|
| Returns
| -------
| plotly.graph_objs.isosurface.Surface
|
| text
| Sets the text elements associated with the vertices. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| value
| Sets the 4th dimension (value) of the vertices.
|
| The 'value' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuehoverformat
| Sets the hover text formatting rulefor `value` using d3
| formatting mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'valuehoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| valuesrc
| Sets the source reference on Chart Studio Cloud for `value`.
|
| The 'valuesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the X coordinates of the vertices on X axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the Y coordinates of the vertices on Y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the Z coordinates of the vertices on Z axis.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Layout(plotly.basedatatypes.BaseLayoutType)
| Layout(arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)
|
| Method resolution order:
| Layout
| plotly.basedatatypes.BaseLayoutType
| plotly.basedatatypes.BaseLayoutHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, activeselection=None, activeshape=None, annotations=None, annotationdefaults=None, autosize=None, autotypenumbers=None, barcornerradius=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, computed=None, datarevision=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendiciclecolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, hoversubplots=None, iciclecolorway=None, images=None, imagedefaults=None, legend=None, map=None, mapbox=None, margin=None, meta=None, metasrc=None, minreducedheight=None, minreducedwidth=None, modebar=None, newselection=None, newshape=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, scattergap=None, scattermode=None, scene=None, selectdirection=None, selectionrevision=None, selections=None, selectiondefaults=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, smith=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)
| Construct a new Layout object
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Layout`
| activeselection
| :class:`plotly.graph_objects.layout.Activeselection`
| instance or dict with compatible properties
| activeshape
| :class:`plotly.graph_objects.layout.Activeshape`
| instance or dict with compatible properties
| annotations
| A tuple of
| :class:`plotly.graph_objects.layout.Annotation`
| instances or dicts with compatible properties
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults), sets the
| default property values to use for elements of
| layout.annotations
| 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.
| autotypenumbers
| Using "strict" a numeric string in trace data is not
| converted to a number. Using *convert types* a numeric
| string in trace data may be treated as a number during
| automatic axis `type` detection. This is the default
| value; however it could be overridden for individual
| axes.
| barcornerradius
| Sets the rounding of bar corners. May be an integer
| number of pixels, or a percentage of bar width (as a
| string ending in %).
| 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 reduce
| "opacity" to see multiple bars.
| barnorm
| Sets the normalization for bar traces on the graph.
| With "fraction", the value of each bar is divided by
| the sum of all values at that location coordinate.
| "percent" is the same but multiplied by 100 to show
| percentages.
| boxgap
| Sets the gap (in plot fraction) between boxes of
| adjacent location coordinates. Has no effect on traces
| that have "width" set.
| boxgroupgap
| Sets the gap (in plot fraction) between boxes of the
| same location coordinate. Has no effect on traces that
| have "width" set.
| boxmode
| Determines how boxes at the same location coordinate
| are displayed on the graph. If "group", the boxes are
| plotted next to one another centered around the shared
| location. If "overlay", the boxes are plotted over one
| another, you might need to set "opacity" to see them
| multiple boxes. Has no effect on traces that have
| "width" set.
| calendar
| Sets the default calendar system to use for
| interpreting and displaying dates throughout the plot.
| clickmode
| Determines the mode of single click interactions.
| "event" is the default value and emits the
| `plotly_click` event. In addition this mode emits the
| `plotly_selected` event in drag modes "lasso" and
| "select", but with no event data attached (kept for
| compatibility reasons). The "select" flag enables
| selecting single data points via click. This mode also
| supports persistent selections, meaning that pressing
| Shift while clicking, adds to / subtracts from an
| existing selection. "select" with `hovermode`: "x" can
| be confusing, consider explicitly setting `hovermode`:
| "closest" when using this feature. Selection events are
| sent accordingly as long as "event" flag is set as
| well. When the "event" flag is missing, `plotly_click`
| and `plotly_selected` events are not fired.
| coloraxis
| :class:`plotly.graph_objects.layout.Coloraxis` instance
| or dict with compatible properties
| colorscale
| :class:`plotly.graph_objects.layout.Colorscale`
| instance or dict with compatible properties
| colorway
| Sets the default trace colors.
| computed
| Placeholder for exporting automargin-impacting values
| namely `margin.t`, `margin.b`, `margin.l` and
| `margin.r` in "full-json" mode.
| 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.
| 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.
| editrevision
| Controls persistence of user-driven changes in
| `editable: true` configuration, other than trace names
| and axis titles. Defaults to `layout.uirevision`.
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether given
| by `funnelareacolorway` or inherited from `colorway`)
| will be extended to three times its original length by
| first repeating every color 20% lighter then each color
| 20% darker. This is intended to reduce the likelihood
| of reusing the same color when you have many slices,
| but you can set `false` to disable. Colors provided in
| the trace, using `marker.colors`, are never extended.
| extendiciclecolors
| If `true`, the icicle slice colors (whether given by
| `iciclecolorway` or inherited from `colorway`) will be
| extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| extendpiecolors
| If `true`, the pie slice colors (whether given by
| `piecolorway` or inherited from `colorway`) will be
| extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether given by
| `sunburstcolorway` or inherited from `colorway`) will
| be extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| extendtreemapcolors
| If `true`, the treemap slice colors (whether given by
| `treemapcolorway` or inherited from `colorway`) will be
| extended to three times its original length by first
| repeating every color 20% lighter then each color 20%
| darker. This is intended to reduce the likelihood of
| reusing the same color when you have many slices, but
| you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
| font
| Sets the global font. Note that fonts used in traces
| and other layout components inherit from the global
| font.
| funnelareacolorway
| Sets the default funnelarea slice colors. Defaults to
| the main `colorway` used for trace colors. If you
| specify a new list here it can still be extended with
| lighter and darker colors, see
| `extendfunnelareacolors`.
| funnelgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of the
| same location coordinate.
| funnelmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "stack", the bars are
| stacked on top of one another With "group", the bars
| are plotted next to one another centered around the
| shared location. With "overlay", the bars are plotted
| over one another, you might need to reduce "opacity" to
| see multiple bars.
| geo
| :class:`plotly.graph_objects.layout.Geo` instance or
| dict with compatible properties
| grid
| :class:`plotly.graph_objects.layout.Grid` instance or
| dict with compatible properties
| height
| Sets the plot's height (in px).
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart analog of
| visible:'legendonly' but it can contain many labels,
| and can simultaneously hide slices from several
| pies/funnelarea charts
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud 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 Chart Studio
| Cloud (at https://chart-studio.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
| :class:`plotly.graph_objects.layout.Hoverlabel`
| instance or dict with compatible properties
| hovermode
| Determines the mode of hover interactions. If
| "closest", a single hoverlabel will appear for the
| "closest" point within the `hoverdistance`. If "x" (or
| "y"), multiple hoverlabels will appear for multiple
| points at the "closest" x- (or y-) coordinate within
| the `hoverdistance`, with the caveat that no more than
| one hoverlabel will appear per trace. If *x unified*
| (or *y unified*), a single hoverlabel will appear
| multiple points at the closest x- (or y-) coordinate
| within the `hoverdistance` with the caveat that no more
| than one hoverlabel will appear per trace. In this
| mode, spikelines are enabled by default perpendicular
| to the specified axis. If false, hover interactions are
| disabled.
| hoversubplots
| Determines expansion of hover effects to other subplots
| If "single" just the axis pair of the primary point is
| included without overlaying subplots. If "overlaying"
| all subplots using the main axis and occupying the same
| space are included. If "axis", also include stacked
| subplots using the same axis when `hovermode` is set to
| "x", *x unified*, "y" or *y unified*.
| iciclecolorway
| Sets the default icicle slice colors. Defaults to the
| main `colorway` used for trace colors. If you specify a
| new list here it can still be extended with lighter and
| darker colors, see `extendiciclecolors`.
| images
| A tuple of :class:`plotly.graph_objects.layout.Image`
| instances or dicts with compatible properties
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the default
| property values to use for elements of layout.images
| legend
| :class:`plotly.graph_objects.layout.Legend` instance or
| dict with compatible properties
| map
| :class:`plotly.graph_objects.layout.Map` instance or
| dict with compatible properties
| mapbox
| :class:`plotly.graph_objects.layout.Mapbox` instance or
| dict with compatible properties
| margin
| :class:`plotly.graph_objects.layout.Margin` instance or
| dict with compatible properties
| meta
| Assigns extra meta information that can be used in
| various `text` attributes. Attributes such as the
| graph, axis and colorbar `title.text`, annotation
| `text` `trace.name` in legend items, `rangeselector`,
| `updatemenus` and `sliders` `label` text all support
| `meta`. One can access `meta` fields using template
| strings: `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an object
| for example `{key: value}` which can be accessed
| %{meta[key]}.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| minreducedheight
| Minimum height of the plot with margin.automargin
| applied (in px)
| minreducedwidth
| Minimum width of the plot with margin.automargin
| applied (in px)
| modebar
| :class:`plotly.graph_objects.layout.Modebar` instance
| or dict with compatible properties
| newselection
| :class:`plotly.graph_objects.layout.Newselection`
| instance or dict with compatible properties
| newshape
| :class:`plotly.graph_objects.layout.Newshape` instance
| or dict with compatible properties
| paper_bgcolor
| Sets the background color of the paper where the graph
| is drawn.
| piecolorway
| Sets the default pie slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new
| list here it can still be extended with lighter and
| darker colors, see `extendpiecolors`.
| plot_bgcolor
| Sets the background color of the plotting area in-
| between x and y axes.
| polar
| :class:`plotly.graph_objects.layout.Polar` instance or
| dict with compatible properties
| scattergap
| Sets the gap (in plot fraction) between scatter points
| of adjacent location coordinates. Defaults to `bargap`.
| scattermode
| Determines how scatter points at the same location
| coordinate are displayed on the graph. With "group",
| the scatter points are plotted next to one another
| centered around the shared location. With "overlay",
| the scatter points are plotted over one another, you
| might need to reduce "opacity" to see multiple scatter
| points.
| scene
| :class:`plotly.graph_objects.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.
| selectionrevision
| Controls persistence of user-driven changes in selected
| points from all traces.
| selections
| A tuple of
| :class:`plotly.graph_objects.layout.Selection`
| instances or dicts with compatible properties
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets the
| default property values to use for elements of
| layout.selections
| 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
| A tuple of :class:`plotly.graph_objects.layout.Shape`
| instances or dicts with compatible properties
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the default
| property values to use for elements of layout.shapes
| showlegend
| Determines whether or not a legend is drawn. Default is
| `true` if there is a trace to show and any of these: a)
| Two or more traces would by default be shown in the
| legend. b) One pie trace is shown in the legend. c) One
| trace is explicitly given with `showlegend: true`.
| sliders
| A tuple of :class:`plotly.graph_objects.layout.Slider`
| instances or dicts with compatible properties
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets the
| default property values to use for elements of
| layout.sliders
| smith
| :class:`plotly.graph_objects.layout.Smith` 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.
| sunburstcolorway
| Sets the default sunburst slice colors. Defaults to the
| main `colorway` used for trace colors. If you specify a
| new list here it can still be extended with lighter and
| darker colors, see `extendsunburstcolors`.
| template
| Default attributes to be applied to the plot. This
| should be a dict with format: `{'layout':
| layoutTemplate, 'data': {trace_type: [traceTemplate,
| ...], ...}}` where `layoutTemplate` is a dict matching
| the structure of `figure.layout` and `traceTemplate` is
| a dict matching the structure of the trace with type
| `trace_type` (e.g. 'scatter'). Alternatively, this may
| be specified as an instance of
| plotly.graph_objs.layout.Template. Trace templates are
| applied cyclically to traces of each type. Container
| arrays (eg `annotations`) have special handling: An
| object ending in `defaults` (eg `annotationdefaults`)
| is applied to each array item. But if an item has a
| `templateitemname` key we look in the template array
| for an item with matching `name` and apply that
| instead. If no matching `name` is found we mark the
| item invisible. Any named template item not referenced
| is appended to the end of the array, so this can be
| used to add a watermark annotation or a logo image, for
| example. To omit one of these items on the plot, make
| an item with matching `templateitemname` and `visible:
| false`.
| ternary
| :class:`plotly.graph_objects.layout.Ternary` instance
| or dict with compatible properties
| title
| :class:`plotly.graph_objects.layout.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use layout.title.font instead. Sets
| the title font. Note that the title's font used to be
| customized by the now deprecated `titlefont` attribute.
| transition
| Sets transition options used during Plotly.react
| updates.
| treemapcolorway
| Sets the default treemap slice colors. Defaults to the
| main `colorway` used for trace colors. If you specify a
| new list here it can still be extended with lighter and
| darker colors, see `extendtreemapcolors`.
| uirevision
| Used to allow user interactions with the plot to
| persist after `Plotly.react` calls that are unaware of
| these interactions. If `uirevision` is omitted, or if
| it is given and it changed from the previous
| `Plotly.react` call, the exact new figure is used. If
| `uirevision` is truthy and did NOT change, any
| attribute that has been affected by user interactions
| and did not receive a different value in the new figure
| will keep the interaction value. `layout.uirevision`
| attribute serves as the default for `uirevision`
| attributes in various sub-containers. For finer control
| you can set these sub-attributes directly. For example,
| if your app separately controls the data on the x and y
| axes you might set `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y data is
| changed, you can update `yaxis.uirevision=*quantity*`
| and the y axis range will reset but the x axis range
| will retain any user-driven zoom.
| uniformtext
| :class:`plotly.graph_objects.layout.Uniformtext`
| instance or dict with compatible properties
| updatemenus
| A tuple of
| :class:`plotly.graph_objects.layout.Updatemenu`
| instances or dicts with compatible properties
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults), sets the
| default property values to use for elements of
| layout.updatemenus
| violingap
| Sets the gap (in plot fraction) between violins of
| adjacent location coordinates. Has no effect on traces
| that have "width" set.
| violingroupgap
| Sets the gap (in plot fraction) between violins of the
| same location coordinate. Has no effect on traces that
| have "width" set.
| violinmode
| Determines how violins at the same location coordinate
| are displayed on the graph. If "group", the violins are
| plotted next to one another centered around the shared
| location. If "overlay", the violins are plotted over
| one another, you might need to set "opacity" to see
| them multiple violins. Has no effect on traces that
| have "width" set.
| waterfallgap
| Sets the gap (in plot fraction) between bars of
| adjacent location coordinates.
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of the
| same location coordinate.
| waterfallmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "group", the bars are
| plotted next to one another centered around the shared
| location. With "overlay", the bars are plotted over one
| another, you might need to reduce "opacity" to see
| multiple bars.
| width
| Sets the plot's width (in px).
| xaxis
| :class:`plotly.graph_objects.layout.XAxis` instance or
| dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.layout.YAxis` instance or
| dict with compatible properties
|
| Returns
| -------
| Layout
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| activeselection
| The 'activeselection' property is an instance of Activeselection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Activeselection`
| - A dict of string/value properties that will be passed
| to the Activeselection constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the color filling the active selection'
| interior.
| opacity
| Sets the opacity of the active selection.
|
| Returns
| -------
| plotly.graph_objs.layout.Activeselection
|
| activeshape
| The 'activeshape' property is an instance of Activeshape
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Activeshape`
| - A dict of string/value properties that will be passed
| to the Activeshape constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the color filling the active shape'
| interior.
| opacity
| Sets the opacity of the active shape.
|
| Returns
| -------
| plotly.graph_objs.layout.Activeshape
|
| annotationdefaults
| When used in a template (as
| layout.template.layout.annotationdefaults), sets the default
| property values to use for elements of layout.annotations
|
| The 'annotationdefaults' property is an instance of Annotation
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Annotation`
| - A dict of string/value properties that will be passed
| to the Annotation constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Annotation
|
| annotations
| The 'annotations' property is a tuple of instances of
| Annotation that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Annotation
| - A list or tuple of dicts of string/value properties that
| will be passed to the Annotation constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the `text`
| within the box. Has an effect only if `text`
| spans two or more lines (i.e. `text` contains
| one or more <br> HTML tags) or if an explicit
| width is set to override the text width.
| arrowcolor
| Sets the color of the annotation arrow.
| arrowhead
| Sets the end annotation arrow head style.
| arrowside
| Sets the annotation arrow head position.
| arrowsize
| Sets the size of the end annotation arrow head,
| relative to `arrowwidth`. A value of 1
| (default) gives a head about 3x as wide as the
| line.
| arrowwidth
| Sets the width (in px) of annotation arrow
| line.
| ax
| Sets the x component of the arrow tail about
| the arrow head. If `axref` is `pixel`, a
| positive (negative) component corresponds to an
| arrow pointing from right to left (left to
| right). If `axref` is not `pixel` and is
| exactly the same as `xref`, this is an absolute
| value on that axis, like `x`, specified in the
| same coordinates as `xref`.
| axref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a x
| axis id (e.g. "x" or "x2"), the `x` position
| refers to a x coordinate. If set to "paper",
| the `x` position refers to the distance from
| the left of the plotting area in normalized
| coordinates where 0 (1) corresponds to the left
| (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the left of the domain of that axis: e.g., *x2
| domain* refers to the domain of the second x
| axis and a x position of 0.5 refers to the
| point between the left and the right of the
| domain of the second x axis. In order for
| absolute positioning of the arrow to work,
| "axref" must be exactly the same as "xref",
| otherwise "axref" will revert to "pixel"
| (explained next). For relative positioning,
| "axref" can be set to "pixel", in which case
| the "ax" value is specified in pixels relative
| to "x". Absolute positioning is useful for
| trendline annotations which should continue to
| indicate the correct trend when zoomed.
| Relative positioning is useful for specifying
| the text offset for an annotated point.
| ay
| Sets the y component of the arrow tail about
| the arrow head. If `ayref` is `pixel`, a
| positive (negative) component corresponds to an
| arrow pointing from bottom to top (top to
| bottom). If `ayref` is not `pixel` and is
| exactly the same as `yref`, this is an absolute
| value on that axis, like `y`, specified in the
| same coordinates as `yref`.
| ayref
| Indicates in what coordinates the tail of the
| annotation (ax,ay) is specified. If set to a y
| axis id (e.g. "y" or "y2"), the `y` position
| refers to a y coordinate. If set to "paper",
| the `y` position refers to the distance from
| the bottom of the plotting area in normalized
| coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the bottom of the domain of that axis: e.g.,
| *y2 domain* refers to the domain of the second
| y axis and a y position of 0.5 refers to the
| point between the bottom and the top of the
| domain of the second y axis. In order for
| absolute positioning of the arrow to work,
| "ayref" must be exactly the same as "yref",
| otherwise "ayref" will revert to "pixel"
| (explained next). For relative positioning,
| "ayref" can be set to "pixel", in which case
| the "ay" value is specified in pixels relative
| to "y". Absolute positioning is useful for
| trendline annotations which should continue to
| indicate the correct trend when zoomed.
| Relative positioning is useful for specifying
| the text offset for an annotated point.
| bgcolor
| Sets the background color of the annotation.
| bordercolor
| Sets the color of the border enclosing the
| annotation `text`.
| borderpad
| Sets the padding (in px) between the `text` and
| the enclosing border.
| borderwidth
| Sets the width (in px) of the border enclosing
| the annotation `text`.
| captureevents
| Determines whether the annotation text box
| captures mouse move and click events, or allows
| those events to pass through to data points in
| the plot that may be behind the annotation. By
| default `captureevents` is False unless
| `hovertext` is provided. If you use the event
| `plotly_clickannotation` without `hovertext`
| you must explicitly enable `captureevents`.
| clicktoshow
| Makes this annotation respond to clicks on the
| plot. If you click a data point that exactly
| matches the `x` and `y` values of this
| annotation, and it is hidden (visible: false),
| it will appear. In "onoff" mode, you must click
| the same point again to make it disappear, so
| if you click multiple points, you can show
| multiple annotations. In "onout" mode, a click
| anywhere else in the plot (on another data
| point or not) will hide this annotation. If you
| need to show/hide this annotation in response
| to different `x` or `y` values, you can set
| `xclick` and/or `yclick`. This is useful for
| example to label the side of a bar. To label
| markers though, `standoff` is preferred over
| `xclick` and `yclick`.
| font
| Sets the annotation text font.
| height
| Sets an explicit height for the text box. null
| (default) lets the text set the box height.
| Taller text will be clipped.
| hoverlabel
| :class:`plotly.graph_objects.layout.annotation.
| Hoverlabel` instance or dict with compatible
| properties
| hovertext
| Sets text to appear when hovering over this
| annotation. If omitted or blank, no hover label
| will appear.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the annotation (text +
| arrow).
| showarrow
| Determines whether or not the annotation is
| drawn with an arrow. If True, `text` is placed
| near the arrow's tail. If False, `text` lines
| up with the `x` and `y` provided.
| standoff
| Sets a distance, in pixels, to move the end
| arrowhead away from the position it is pointing
| at, for example to point at the edge of a
| marker independent of zoom. Note that this
| shortens the arrow from the `ax` / `ay` vector,
| in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| startarrowhead
| Sets the start annotation arrow head style.
| startarrowsize
| Sets the size of the start annotation arrow
| head, relative to `arrowwidth`. A value of 1
| (default) gives a head about 3x as wide as the
| line.
| startstandoff
| Sets a distance, in pixels, to move the start
| arrowhead away from the position it is pointing
| at, for example to point at the edge of a
| marker independent of zoom. Note that this
| shortens the arrow from the `ax` / `ay` vector,
| in contrast to `xshift` / `yshift` which moves
| everything by this amount.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| text
| Sets the text associated with this annotation.
| Plotly uses a subset of HTML tags to do things
| like newline (<br>), bold (<b></b>), italics
| (<i></i>), hyperlinks (<a href='...'></a>).
| Tags <em>, <sup>, <sub>, <s>, <u> <span> are
| also supported.
| textangle
| Sets the angle at which the `text` is drawn
| with respect to the horizontal.
| valign
| Sets the vertical alignment of the `text`
| within the box. Has an effect only if an
| explicit height is set to override the text
| height.
| visible
| Determines whether or not this annotation is
| visible.
| width
| Sets an explicit width for the text box. null
| (default) lets the text set the box width.
| Wider text will be clipped. There is no
| automatic wrapping; use <br> to start a new
| line.
| x
| Sets the annotation's x position. If the axis
| `type` is "log", then you must take the log of
| your desired range. If the axis `type` is
| "date", it should be date strings, like date
| data, though Date objects and unix milliseconds
| will be accepted and converted to strings. If
| the axis `type` is "category", it should be
| numbers, using the scale where each category is
| assigned a serial number from zero in the order
| it appears.
| xanchor
| Sets the text box's horizontal position anchor
| This anchor binds the `x` position to the
| "left", "center" or "right" of the annotation.
| For example, if `x` is set to 1, `xref` to
| "paper" and `xanchor` to "right" then the
| right-most portion of the annotation lines up
| with the right-most edge of the plotting area.
| If "auto", the anchor is equivalent to "center"
| for data-referenced annotations or if there is
| an arrow, whereas for paper-referenced with no
| arrow, the anchor picked corresponds to the
| closest side.
| xclick
| Toggle this annotation when clicking a data
| point whose `x` value is `xclick` rather than
| the annotation's `x` value.
| xref
| Sets the annotation's x coordinate axis. If set
| to a x axis id (e.g. "x" or "x2"), the `x`
| position refers to a x coordinate. If set to
| "paper", the `x` position refers to the
| distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID
| followed by "domain" (separated by a space),
| the position behaves like for "paper", but
| refers to the distance in fractions of the
| domain length from the left of the domain of
| that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position
| of 0.5 refers to the point between the left and
| the right of the domain of the second x axis.
| xshift
| Shifts the position of the whole annotation and
| arrow to the right (positive) or left
| (negative) by this many pixels.
| y
| Sets the annotation's y position. If the axis
| `type` is "log", then you must take the log of
| your desired range. If the axis `type` is
| "date", it should be date strings, like date
| data, though Date objects and unix milliseconds
| will be accepted and converted to strings. If
| the axis `type` is "category", it should be
| numbers, using the scale where each category is
| assigned a serial number from zero in the order
| it appears.
| yanchor
| Sets the text box's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the annotation.
| For example, if `y` is set to 1, `yref` to
| "paper" and `yanchor` to "top" then the top-
| most portion of the annotation lines up with
| the top-most edge of the plotting area. If
| "auto", the anchor is equivalent to "middle"
| for data-referenced annotations or if there is
| an arrow, whereas for paper-referenced with no
| arrow, the anchor picked corresponds to the
| closest side.
| yclick
| Toggle this annotation when clicking a data
| point whose `y` value is `yclick` rather than
| the annotation's `y` value.
| yref
| Sets the annotation's y coordinate axis. If set
| to a y axis id (e.g. "y" or "y2"), the `y`
| position refers to a y coordinate. If set to
| "paper", the `y` position refers to the
| distance from the bottom of the plotting area
| in normalized coordinates where 0 (1)
| corresponds to the bottom (top). If set to a y
| axis ID followed by "domain" (separated by a
| space), the position behaves like for "paper",
| but refers to the distance in fractions of the
| domain length from the bottom of the domain of
| that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position
| of 0.5 refers to the point between the bottom
| and the top of the domain of the second y axis.
| yshift
| Shifts the position of the whole annotation and
| arrow up (positive) or down (negative) by this
| many pixels.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Annotation]
|
| autosize
| Determines whether or not a layout width or height that has
| been left undefined by the user is initialized on each
| relayout. Note that, regardless of this attribute, an undefined
| layout width or height is always initialized on the first call
| to plot.
|
| The 'autosize' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| autotypenumbers
| Using "strict" a numeric string in trace data is not converted
| to a number. Using *convert types* a numeric string in trace
| data may be treated as a number during automatic axis `type`
| detection. This is the default value; however it could be
| overridden for individual axes.
|
| The 'autotypenumbers' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['convert types', 'strict']
|
| Returns
| -------
| Any
|
| barcornerradius
| Sets the rounding of bar corners. May be an integer number of
| pixels, or a percentage of bar width (as a string ending in %).
|
| The 'barcornerradius' property accepts values of any type
|
| Returns
| -------
| Any
|
| bargap
| Sets the gap (in plot fraction) between bars of adjacent
| location coordinates.
|
| The 'bargap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| bargroupgap
| Sets the gap (in plot fraction) between bars of the same
| location coordinate.
|
| The 'bargroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| barmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "stack", the bars are stacked on
| top of one another With "relative", the bars are stacked on top
| of one another, with negative values below the axis, positive
| values above With "group", the bars are plotted next to one
| another centered around the shared location. With "overlay",
| the bars are plotted over one another, you might need to reduce
| "opacity" to see multiple bars.
|
| The 'barmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['stack', 'group', 'overlay', 'relative']
|
| Returns
| -------
| Any
|
| barnorm
| Sets the normalization for bar traces on the graph. With
| "fraction", the value of each bar is divided by the sum of all
| values at that location coordinate. "percent" is the same but
| multiplied by 100 to show percentages.
|
| The 'barnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'fraction', 'percent']
|
| Returns
| -------
| Any
|
| boxgap
| Sets the gap (in plot fraction) between boxes of adjacent
| location coordinates. Has no effect on traces that have "width"
| set.
|
| The 'boxgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| boxgroupgap
| Sets the gap (in plot fraction) between boxes of the same
| location coordinate. Has no effect on traces that have "width"
| set.
|
| The 'boxgroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| boxmode
| Determines how boxes at the same location coordinate are
| displayed on the graph. If "group", the boxes are plotted next
| to one another centered around the shared location. If
| "overlay", the boxes are plotted over one another, you might
| need to set "opacity" to see them multiple boxes. Has no effect
| on traces that have "width" set.
|
| The 'boxmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| calendar
| Sets the default calendar system to use for interpreting and
| displaying dates throughout the plot.
|
| The 'calendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| clickmode
| Determines the mode of single click interactions. "event" is
| the default value and emits the `plotly_click` event. In
| addition this mode emits the `plotly_selected` event in drag
| modes "lasso" and "select", but with no event data attached
| (kept for compatibility reasons). The "select" flag enables
| selecting single data points via click. This mode also supports
| persistent selections, meaning that pressing Shift while
| clicking, adds to / subtracts from an existing selection.
| "select" with `hovermode`: "x" can be confusing, consider
| explicitly setting `hovermode`: "closest" when using this
| feature. Selection events are sent accordingly as long as
| "event" flag is set as well. When the "event" flag is missing,
| `plotly_click` and `plotly_selected` events are not fired.
|
| The 'clickmode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['event', 'select'] joined with '+' characters
| (e.g. 'event+select')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| coloraxis
| The 'coloraxis' property is an instance of Coloraxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Coloraxis`
| - A dict of string/value properties that will be passed
| to the Coloraxis constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `colorscale`. In case
| `colorscale` is unspecified or `autocolorscale`
| is true, the default palette will be chosen
| according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| corresponding trace color array(s)) or the
| bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the
| user.
| cmax
| Sets the upper bound of the color domain. Value
| should have the same units as corresponding
| trace color array(s) and if set, `cmin` must be
| set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `cmin` and/or `cmax` to be equidistant
| to this point. Value should have the same units
| as corresponding trace color array(s). Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value
| should have the same units as corresponding
| trace color array(s) and if set, `cmax` must be
| set as well.
| colorbar
| :class:`plotly.graph_objects.layout.coloraxis.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. The colorscale must be an
| array containing arrays mapping a normalized
| value to an rgb, rgba, hex, hsl, hsv, or named
| color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required.
| For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and
| `cmax`. Alternatively, `colorscale` may be a
| palette name string of the following list: Blac
| kbody,Bluered,Blues,Cividis,Earth,Electric,Gree
| ns,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,R
| eds,Viridis,YlGnBu,YlOrRd.
| reversescale
| Reverses the color mapping if true. If true,
| `cmin` will correspond to the last color in the
| array and `cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace.
|
| Returns
| -------
| plotly.graph_objs.layout.Coloraxis
|
| colorscale
| The 'colorscale' property is an instance of Colorscale
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Colorscale`
| - A dict of string/value properties that will be passed
| to the Colorscale constructor
|
| Supported dict properties:
|
| diverging
| Sets the default diverging colorscale. Note
| that `autocolorscale` must be true for this
| attribute to work.
| sequential
| Sets the default sequential colorscale for
| positive values. Note that `autocolorscale`
| must be true for this attribute to work.
| sequentialminus
| Sets the default sequential colorscale for
| negative values. Note that `autocolorscale`
| must be true for this attribute to work.
|
| Returns
| -------
| plotly.graph_objs.layout.Colorscale
|
| colorway
| Sets the default trace colors.
|
| The 'colorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| computed
| Placeholder for exporting automargin-impacting values namely
| `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-
| json" mode.
|
| The 'computed' property accepts values of any type
|
| Returns
| -------
| Any
|
| datarevision
| If provided, a changed value tells `Plotly.react` that one or
| more data arrays has changed. This way you can modify arrays
| in-place rather than making a complete new copy for an
| incremental change. If NOT provided, `Plotly.react` assumes
| that data arrays are being treated as immutable, thus any data
| array with a different identity from its predecessor contains
| new data.
|
| The 'datarevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| dragmode
| Determines the mode of drag interactions. "select" and "lasso"
| apply only to scatter traces with markers or text. "orbit" and
| "turntable" apply only to 3D scenes.
|
| The 'dragmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['zoom', 'pan', 'select', 'lasso', 'drawclosedpath',
| 'drawopenpath', 'drawline', 'drawrect', 'drawcircle',
| 'orbit', 'turntable', False]
|
| Returns
| -------
| Any
|
| editrevision
| Controls persistence of user-driven changes in `editable: true`
| configuration, other than trace names and axis titles. Defaults
| to `layout.uirevision`.
|
| The 'editrevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| extendfunnelareacolors
| If `true`, the funnelarea slice colors (whether given by
| `funnelareacolorway` or inherited from `colorway`) will be
| extended to three times its original length by first repeating
| every color 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing the same color
| when you have many slices, but you can set `false` to disable.
| Colors provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendfunnelareacolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendiciclecolors
| If `true`, the icicle slice colors (whether given by
| `iciclecolorway` or inherited from `colorway`) will be extended
| to three times its original length by first repeating every
| color 20% lighter then each color 20% darker. This is intended
| to reduce the likelihood of reusing the same color when you
| have many slices, but you can set `false` to disable. Colors
| provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendiciclecolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendpiecolors
| If `true`, the pie slice colors (whether given by `piecolorway`
| or inherited from `colorway`) will be extended to three times
| its original length by first repeating every color 20% lighter
| then each color 20% darker. This is intended to reduce the
| likelihood of reusing the same color when you have many slices,
| but you can set `false` to disable. Colors provided in the
| trace, using `marker.colors`, are never extended.
|
| The 'extendpiecolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendsunburstcolors
| If `true`, the sunburst slice colors (whether given by
| `sunburstcolorway` or inherited from `colorway`) will be
| extended to three times its original length by first repeating
| every color 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing the same color
| when you have many slices, but you can set `false` to disable.
| Colors provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendsunburstcolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| extendtreemapcolors
| If `true`, the treemap slice colors (whether given by
| `treemapcolorway` or inherited from `colorway`) will be
| extended to three times its original length by first repeating
| every color 20% lighter then each color 20% darker. This is
| intended to reduce the likelihood of reusing the same color
| when you have many slices, but you can set `false` to disable.
| Colors provided in the trace, using `marker.colors`, are never
| extended.
|
| The 'extendtreemapcolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| font
| Sets the global font. Note that fonts used in traces and other
| layout components inherit from the global font.
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.layout.Font
|
| funnelareacolorway
| Sets the default funnelarea slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendfunnelareacolors`.
|
| The 'funnelareacolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| funnelgap
| Sets the gap (in plot fraction) between bars of adjacent
| location coordinates.
|
| The 'funnelgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| funnelgroupgap
| Sets the gap (in plot fraction) between bars of the same
| location coordinate.
|
| The 'funnelgroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| funnelmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "stack", the bars are stacked on
| top of one another With "group", the bars are plotted next to
| one another centered around the shared location. With
| "overlay", the bars are plotted over one another, you might
| need to reduce "opacity" to see multiple bars.
|
| The 'funnelmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['stack', 'group', 'overlay']
|
| Returns
| -------
| Any
|
| geo
| The 'geo' property is an instance of Geo
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Geo`
| - A dict of string/value properties that will be passed
| to the Geo constructor
|
| Supported dict properties:
|
| bgcolor
| Set the background color of the map
| center
| :class:`plotly.graph_objects.layout.geo.Center`
| instance or dict with compatible properties
| coastlinecolor
| Sets the coastline color.
| coastlinewidth
| Sets the coastline stroke width (in px).
| countrycolor
| Sets line color of the country boundaries.
| countrywidth
| Sets line width (in px) of the country
| boundaries.
| domain
| :class:`plotly.graph_objects.layout.geo.Domain`
| instance or dict with compatible properties
| fitbounds
| Determines if this subplot's view settings are
| auto-computed to fit trace data. On scoped
| maps, setting `fitbounds` leads to `center.lon`
| and `center.lat` getting auto-filled. On maps
| with a non-clipped projection, setting
| `fitbounds` leads to `center.lon`,
| `center.lat`, and `projection.rotation.lon`
| getting auto-filled. On maps with a clipped
| projection, setting `fitbounds` leads to
| `center.lon`, `center.lat`,
| `projection.rotation.lon`,
| `projection.rotation.lat`, `lonaxis.range` and
| `lonaxis.range` getting auto-filled. If
| "locations", only the trace's visible locations
| are considered in the `fitbounds` computations.
| If "geojson", the entire trace input `geojson`
| (if provided) is considered in the `fitbounds`
| computations, Defaults to False.
| framecolor
| Sets the color the frame.
| framewidth
| Sets the stroke width (in px) of the frame.
| lakecolor
| Sets the color of the lakes.
| landcolor
| Sets the land mass color.
| lataxis
| :class:`plotly.graph_objects.layout.geo.Lataxis
| ` instance or dict with compatible properties
| lonaxis
| :class:`plotly.graph_objects.layout.geo.Lonaxis
| ` instance or dict with compatible properties
| oceancolor
| Sets the ocean color
| projection
| :class:`plotly.graph_objects.layout.geo.Project
| ion` instance or dict with compatible
| properties
| resolution
| Sets the resolution of the base layers. The
| values have units of km/mm e.g. 110 corresponds
| to a scale ratio of 1:110,000,000.
| rivercolor
| Sets color of the rivers.
| riverwidth
| Sets the stroke width (in px) of the rivers.
| scope
| Set the scope of the map.
| showcoastlines
| Sets whether or not the coastlines are drawn.
| showcountries
| Sets whether or not country boundaries are
| drawn.
| showframe
| Sets whether or not a frame is drawn around the
| map.
| showlakes
| Sets whether or not lakes are drawn.
| showland
| Sets whether or not land masses are filled in
| color.
| showocean
| Sets whether or not oceans are filled in color.
| showrivers
| Sets whether or not rivers are drawn.
| showsubunits
| Sets whether or not boundaries of subunits
| within countries (e.g. states, provinces) are
| drawn.
| subunitcolor
| Sets the color of the subunits boundaries.
| subunitwidth
| Sets the stroke width (in px) of the subunits
| boundaries.
| uirevision
| Controls persistence of user-driven changes in
| the view (projection and center). Defaults to
| `layout.uirevision`.
| visible
| Sets the default visibility of the base layers.
|
| Returns
| -------
| plotly.graph_objs.layout.Geo
|
| grid
| The 'grid' property is an instance of Grid
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Grid`
| - A dict of string/value properties that will be passed
| to the Grid constructor
|
| Supported dict properties:
|
| columns
| The number of columns in the grid. If you
| provide a 2D `subplots` array, the length of
| its longest row is used as the default. If you
| give an `xaxes` array, its length is used as
| the default. But it's also possible to have a
| different length, if you want to leave a row at
| the end for non-cartesian subplots.
| domain
| :class:`plotly.graph_objects.layout.grid.Domain
| ` instance or dict with compatible properties
| pattern
| If no `subplots`, `xaxes`, or `yaxes` are given
| but we do have `rows` and `columns`, we can
| generate defaults using consecutive axis IDs,
| in two ways: "coupled" gives one x axis per
| column and one y axis per row. "independent"
| uses a new xy pair for each cell, left-to-right
| across each row then iterating rows according
| to `roworder`.
| roworder
| Is the first row the top or the bottom? Note
| that columns are always enumerated from left to
| right.
| rows
| The number of rows in the grid. If you provide
| a 2D `subplots` array or a `yaxes` array, its
| length is used as the default. But it's also
| possible to have a different length, if you
| want to leave a row at the end for non-
| cartesian subplots.
| subplots
| Used for freeform grids, where some axes may be
| shared across subplots but others are not. Each
| entry should be a cartesian subplot id, like
| "xy" or "x3y2", or "" to leave that cell empty.
| You may reuse x axes within the same column,
| and y axes within the same row. Non-cartesian
| subplots and traces that support `domain` can
| place themselves in this grid separately using
| the `gridcell` attribute.
| xaxes
| Used with `yaxes` when the x and y axes are
| shared across columns and rows. Each entry
| should be an x axis id like "x", "x2", etc., or
| "" to not put an x axis in that column. Entries
| other than "" must be unique. Ignored if
| `subplots` is present. If missing but `yaxes`
| is present, will generate consecutive IDs.
| xgap
| Horizontal space between grid cells, expressed
| as a fraction of the total width available to
| one cell. Defaults to 0.1 for coupled-axes
| grids and 0.2 for independent grids.
| xside
| Sets where the x axis labels and titles go.
| "bottom" means the very bottom of the grid.
| "bottom plot" is the lowest plot that each x
| axis is used in. "top" and "top plot" are
| similar.
| yaxes
| Used with `yaxes` when the x and y axes are
| shared across columns and rows. Each entry
| should be an y axis id like "y", "y2", etc., or
| "" to not put a y axis in that row. Entries
| other than "" must be unique. Ignored if
| `subplots` is present. If missing but `xaxes`
| is present, will generate consecutive IDs.
| ygap
| Vertical space between grid cells, expressed as
| a fraction of the total height available to one
| cell. Defaults to 0.1 for coupled-axes grids
| and 0.3 for independent grids.
| yside
| Sets where the y axis labels and titles go.
| "left" means the very left edge of the grid.
| *left plot* is the leftmost plot that each y
| axis is used in. "right" and *right plot* are
| similar.
|
| Returns
| -------
| plotly.graph_objs.layout.Grid
|
| height
| Sets the plot's height (in px).
|
| The 'height' property is a number and may be specified as:
| - An int or float in the interval [10, inf]
|
| Returns
| -------
| int|float
|
| hiddenlabels
| hiddenlabels is the funnelarea & pie chart analog of
| visible:'legendonly' but it can contain many labels, and can
| simultaneously hide slices from several pies/funnelarea charts
|
| The 'hiddenlabels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| hiddenlabelssrc
| Sets the source reference on Chart Studio Cloud for
| `hiddenlabels`.
|
| The 'hiddenlabelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hidesources
| Determines whether or not a text link citing the data source is
| placed at the bottom-right cored of the figure. Has only an
| effect only on graphs that have been generated via forked
| graphs from the Chart Studio Cloud (at https://chart-
| studio.plotly.com or on-premise).
|
| The 'hidesources' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverdistance
| Sets the default distance (in pixels) to look for data to add
| hover labels (-1 means no cutoff, 0 means no looking for data).
| This is only a real distance for hovering on point-like
| objects, like scatter points. For area-like objects (bars,
| scatter fills, etc) hovering is on inside the area and off
| outside, but these objects will not supersede hover on point-
| like objects in case of conflict.
|
| The 'hoverdistance' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [-1, 9223372036854775807]
|
| Returns
| -------
| int
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| bgcolor
| Sets the background color of all hover labels
| on graph
| bordercolor
| Sets the border color of all hover labels on
| graph.
| font
| Sets the default hover label font used by all
| traces on the graph.
| grouptitlefont
| Sets the font for group titles in hover
| (unified modes). Defaults to `hoverlabel.font`.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
|
| Returns
| -------
| plotly.graph_objs.layout.Hoverlabel
|
| hovermode
| Determines the mode of hover interactions. If "closest", a
| single hoverlabel will appear for the "closest" point within
| the `hoverdistance`. If "x" (or "y"), multiple hoverlabels will
| appear for multiple points at the "closest" x- (or y-)
| coordinate within the `hoverdistance`, with the caveat that no
| more than one hoverlabel will appear per trace. If *x unified*
| (or *y unified*), a single hoverlabel will appear multiple
| points at the closest x- (or y-) coordinate within the
| `hoverdistance` with the caveat that no more than one
| hoverlabel will appear per trace. In this mode, spikelines are
| enabled by default perpendicular to the specified axis. If
| false, hover interactions are disabled.
|
| The 'hovermode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['x', 'y', 'closest', False, 'x unified', 'y unified']
|
| Returns
| -------
| Any
|
| hoversubplots
| Determines expansion of hover effects to other subplots If
| "single" just the axis pair of the primary point is included
| without overlaying subplots. If "overlaying" all subplots using
| the main axis and occupying the same space are included. If
| "axis", also include stacked subplots using the same axis when
| `hovermode` is set to "x", *x unified*, "y" or *y unified*.
|
| The 'hoversubplots' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['single', 'overlaying', 'axis']
|
| Returns
| -------
| Any
|
| iciclecolorway
| Sets the default icicle slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendiciclecolors`.
|
| The 'iciclecolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| imagedefaults
| When used in a template (as
| layout.template.layout.imagedefaults), sets the default
| property values to use for elements of layout.images
|
| The 'imagedefaults' property is an instance of Image
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Image`
| - A dict of string/value properties that will be passed
| to the Image constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Image
|
| images
| The 'images' property is a tuple of instances of
| Image that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Image
| - A list or tuple of dicts of string/value properties that
| will be passed to the Image constructor
|
| Supported dict properties:
|
| layer
| Specifies whether images are drawn below or
| above traces. When `xref` and `yref` are both
| set to `paper`, image is drawn below the entire
| plot area.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the image.
| sizex
| Sets the image container size horizontally. The
| image will be sized based on the `position`
| value. When `xref` is set to `paper`, units are
| sized relative to the plot width. When `xref`
| ends with ` domain`, units are sized relative
| to the axis width.
| sizey
| Sets the image container size vertically. The
| image will be sized based on the `position`
| value. When `yref` is set to `paper`, units are
| sized relative to the plot height. When `yref`
| ends with ` domain`, units are sized relative
| to the axis height.
| sizing
| Specifies which dimension of the image to
| constrain.
| source
| Specifies the URL of the image to be used. The
| URL must be accessible from the domain where
| the plot code is run, and can be either
| relative or absolute.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| visible
| Determines whether or not this image is
| visible.
| x
| Sets the image's x position. When `xref` is set
| to `paper`, units are sized relative to the
| plot height. See `xref` for more info
| xanchor
| Sets the anchor for the x position
| xref
| Sets the images's x coordinate axis. If set to
| a x axis id (e.g. "x" or "x2"), the `x`
| position refers to a x coordinate. If set to
| "paper", the `x` position refers to the
| distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID
| followed by "domain" (separated by a space),
| the position behaves like for "paper", but
| refers to the distance in fractions of the
| domain length from the left of the domain of
| that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position
| of 0.5 refers to the point between the left and
| the right of the domain of the second x axis.
| y
| Sets the image's y position. When `yref` is set
| to `paper`, units are sized relative to the
| plot height. See `yref` for more info
| yanchor
| Sets the anchor for the y position.
| yref
| Sets the images's y coordinate axis. If set to
| a y axis id (e.g. "y" or "y2"), the `y`
| position refers to a y coordinate. If set to
| "paper", the `y` position refers to the
| distance from the bottom of the plotting area
| in normalized coordinates where 0 (1)
| corresponds to the bottom (top). If set to a y
| axis ID followed by "domain" (separated by a
| space), the position behaves like for "paper",
| but refers to the distance in fractions of the
| domain length from the bottom of the domain of
| that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position
| of 0.5 refers to the point between the bottom
| and the top of the domain of the second y axis.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Image]
|
| legend
| The 'legend' property is an instance of Legend
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Legend`
| - A dict of string/value properties that will be passed
| to the Legend constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the legend background color. Defaults to
| `layout.paper_bgcolor`.
| bordercolor
| Sets the color of the border enclosing the
| legend.
| borderwidth
| Sets the width (in px) of the border enclosing
| the legend.
| entrywidth
| Sets the width (in px or fraction) of the
| legend. Use 0 to size the entry based on the
| text width, when `entrywidthmode` is set to
| "pixels".
| entrywidthmode
| Determines what entrywidth means.
| font
| Sets the font used to text the legend items.
| groupclick
| Determines the behavior on legend group item
| click. "toggleitem" toggles the visibility of
| the individual item clicked on the graph.
| "togglegroup" toggles the visibility of all
| items in the same legendgroup as the item
| clicked on the graph.
| grouptitlefont
| Sets the font for group titles in legend.
| Defaults to `legend.font` with its size
| increased about 10%.
| indentation
| Sets the indentation (in px) of the legend
| entries.
| itemclick
| Determines the behavior on legend item click.
| "toggle" toggles the visibility of the item
| clicked on the graph. "toggleothers" makes the
| clicked item the sole visible item on the
| graph. False disables legend item click
| interactions.
| itemdoubleclick
| Determines the behavior on legend item double-
| click. "toggle" toggles the visibility of the
| item clicked on the graph. "toggleothers" makes
| the clicked item the sole visible item on the
| graph. False disables legend item double-click
| interactions.
| itemsizing
| Determines if the legend items symbols scale
| with their corresponding "trace" attributes or
| remain "constant" independent of the symbol
| size on the graph.
| itemwidth
| Sets the width (in px) of the legend item
| symbols (the part other than the title.text).
| orientation
| Sets the orientation of the legend.
| title
| :class:`plotly.graph_objects.layout.legend.Titl
| e` instance or dict with compatible properties
| tracegroupgap
| Sets the amount of vertical space (in px)
| between legend groups.
| traceorder
| Determines the order at which the legend items
| are displayed. If "normal", the items are
| displayed top-to-bottom in the same order as
| the input data. If "reversed", the items are
| displayed in the opposite order as "normal". If
| "grouped", the items are displayed in groups
| (when a trace `legendgroup` is provided). if
| "grouped+reversed", the items are displayed in
| the opposite order as "grouped".
| uirevision
| Controls persistence of legend-driven changes
| in trace and pie label visibility. Defaults to
| `layout.uirevision`.
| valign
| Sets the vertical alignment of the symbols with
| respect to their associated text.
| visible
| Determines whether or not this legend is
| visible.
| x
| Sets the x position with respect to `xref` (in
| normalized coordinates) of the legend. When
| `xref` is "paper", defaults to 1.02 for
| vertical legends and defaults to 0 for
| horizontal legends. When `xref` is "container",
| defaults to 1 for vertical legends and defaults
| to 0 for horizontal legends. Must be between 0
| and 1 if `xref` is "container". and between
| "-2" and 3 if `xref` is "paper".
| xanchor
| Sets the legend's horizontal position anchor.
| This anchor binds the `x` position to the
| "left", "center" or "right" of the legend.
| Value "auto" anchors legends to the right for
| `x` values greater than or equal to 2/3,
| anchors legends to the left for `x` values less
| than or equal to 1/3 and anchors legends with
| respect to their center otherwise.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` (in
| normalized coordinates) of the legend. When
| `yref` is "paper", defaults to 1 for vertical
| legends, defaults to "-0.1" for horizontal
| legends on graphs w/o range sliders and
| defaults to 1.1 for horizontal legends on graph
| with one or multiple range sliders. When `yref`
| is "container", defaults to 1. Must be between
| 0 and 1 if `yref` is "container" and between
| "-2" and 3 if `yref` is "paper".
| yanchor
| Sets the legend's vertical position anchor This
| anchor binds the `y` position to the "top",
| "middle" or "bottom" of the legend. Value
| "auto" anchors legends at their bottom for `y`
| values less than or equal to 1/3, anchors
| legends to at their top for `y` values greater
| than or equal to 2/3 and anchors legends with
| respect to their middle otherwise.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.layout.Legend
|
| map
| The 'map' property is an instance of Map
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Map`
| - A dict of string/value properties that will be passed
| to the Map constructor
|
| Supported dict properties:
|
| bearing
| Sets the bearing angle of the map in degrees
| counter-clockwise from North (map.bearing).
| bounds
| :class:`plotly.graph_objects.layout.map.Bounds`
| instance or dict with compatible properties
| center
| :class:`plotly.graph_objects.layout.map.Center`
| instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.map.Domain`
| instance or dict with compatible properties
| layers
| A tuple of
| :class:`plotly.graph_objects.layout.map.Layer`
| instances or dicts with compatible properties
| layerdefaults
| When used in a template (as
| layout.template.layout.map.layerdefaults), sets
| the default property values to use for elements
| of layout.map.layers
| pitch
| Sets the pitch angle of the map (in degrees,
| where 0 means perpendicular to the surface of
| the map) (map.pitch).
| style
| Defines the map layers that are rendered by
| default below the trace layers defined in
| `data`, which are themselves by default
| rendered below the layers defined in
| `layout.map.layers`. These layers can be
| defined either explicitly as a Map Style object
| which can contain multiple layer definitions
| that load data from any public or private Tile
| Map Service (TMS or XYZ) or Web Map Service
| (WMS) or implicitly by using one of the built-
| in style objects which use WMSes or by using a
| custom style URL Map Style objects are of the
| form described in the MapLibre GL JS
| documentation available at
| https://maplibre.org/maplibre-style-spec/ The
| built-in plotly.js styles objects are: basic,
| carto-darkmatter, carto-darkmatter-nolabels,
| carto-positron, carto-positron-nolabels, carto-
| voyager, carto-voyager-nolabels, dark, light,
| open-street-map, outdoors, satellite,
| satellite-streets, streets, white-bg.
| uirevision
| Controls persistence of user-driven changes in
| the view: `center`, `zoom`, `bearing`, `pitch`.
| Defaults to `layout.uirevision`.
| zoom
| Sets the zoom level of the map (map.zoom).
|
| Returns
| -------
| plotly.graph_objs.layout.Map
|
| mapbox
| The 'mapbox' property is an instance of Mapbox
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Mapbox`
| - A dict of string/value properties that will be passed
| to the Mapbox constructor
|
| Supported dict properties:
|
| accesstoken
| Sets the mapbox access token to be used for
| this mapbox map. Alternatively, the mapbox
| access token can be set in the configuration
| options under `mapboxAccessToken`. Note that
| accessToken are only required when `style` (e.g
| with values : basic, streets, outdoors, light,
| dark, satellite, satellite-streets ) and/or a
| layout layer references the Mapbox server.
| bearing
| Sets the bearing angle of the map in degrees
| counter-clockwise from North (mapbox.bearing).
| bounds
| :class:`plotly.graph_objects.layout.mapbox.Boun
| ds` instance or dict with compatible properties
| center
| :class:`plotly.graph_objects.layout.mapbox.Cent
| er` instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.mapbox.Doma
| in` instance or dict with compatible properties
| layers
| A tuple of :class:`plotly.graph_objects.layout.
| mapbox.Layer` instances or dicts with
| compatible properties
| layerdefaults
| When used in a template (as
| layout.template.layout.mapbox.layerdefaults),
| sets the default property values to use for
| elements of layout.mapbox.layers
| pitch
| Sets the pitch angle of the map (in degrees,
| where 0 means perpendicular to the surface of
| the map) (mapbox.pitch).
| style
| Defines the map layers that are rendered by
| default below the trace layers defined in
| `data`, which are themselves by default
| rendered below the layers defined in
| `layout.mapbox.layers`. These layers can be
| defined either explicitly as a Mapbox Style
| object which can contain multiple layer
| definitions that load data from any public or
| private Tile Map Service (TMS or XYZ) or Web
| Map Service (WMS) or implicitly by using one of
| the built-in style objects which use WMSes
| which do not require any access tokens, or by
| using a default Mapbox style or custom Mapbox
| style URL, both of which require a Mapbox
| access token Note that Mapbox access token can
| be set in the `accesstoken` attribute or in the
| `mapboxAccessToken` config option. Mapbox
| Style objects are of the form described in the
| Mapbox GL JS documentation available at
| https://docs.mapbox.com/mapbox-gl-js/style-spec
| The built-in plotly.js styles objects are:
| carto-darkmatter, carto-positron, open-street-
| map, stamen-terrain, stamen-toner, stamen-
| watercolor, white-bg The built-in Mapbox
| styles are: basic, streets, outdoors, light,
| dark, satellite, satellite-streets Mapbox
| style URLs are of the form:
| mapbox://mapbox.mapbox-<name>-<version>
| uirevision
| Controls persistence of user-driven changes in
| the view: `center`, `zoom`, `bearing`, `pitch`.
| Defaults to `layout.uirevision`.
| zoom
| Sets the zoom level of the map (mapbox.zoom).
|
| Returns
| -------
| plotly.graph_objs.layout.Mapbox
|
| margin
| The 'margin' property is an instance of Margin
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Margin`
| - A dict of string/value properties that will be passed
| to the Margin constructor
|
| Supported dict properties:
|
| autoexpand
| Turns on/off margin expansion computations.
| Legends, colorbars, updatemenus, sliders, axis
| rangeselector and rangeslider are allowed to
| push the margins by defaults.
| b
| Sets the bottom margin (in px).
| l
| Sets the left margin (in px).
| pad
| Sets the amount of padding (in px) between the
| plotting area and the axis lines
| r
| Sets the right margin (in px).
| t
| Sets the top margin (in px).
|
| Returns
| -------
| plotly.graph_objs.layout.Margin
|
| meta
| Assigns extra meta information that can be used in various
| `text` attributes. Attributes such as the graph, axis and
| colorbar `title.text`, annotation `text` `trace.name` in legend
| items, `rangeselector`, `updatemenus` and `sliders` `label`
| text all support `meta`. One can access `meta` fields using
| template strings: `%{meta[i]}` where `i` is the index of the
| `meta` item in question. `meta` can also be an object for
| example `{key: value}` which can be accessed %{meta[key]}.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| minreducedheight
| Minimum height of the plot with margin.automargin applied (in
| px)
|
| The 'minreducedheight' property is a number and may be specified as:
| - An int or float in the interval [2, inf]
|
| Returns
| -------
| int|float
|
| minreducedwidth
| Minimum width of the plot with margin.automargin applied (in
| px)
|
| The 'minreducedwidth' property is a number and may be specified as:
| - An int or float in the interval [2, inf]
|
| Returns
| -------
| int|float
|
| modebar
| The 'modebar' property is an instance of Modebar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Modebar`
| - A dict of string/value properties that will be passed
| to the Modebar constructor
|
| Supported dict properties:
|
| activecolor
| Sets the color of the active or hovered on
| icons in the modebar.
| add
| Determines which predefined modebar buttons to
| add. Please note that these buttons will only
| be shown if they are compatible with all trace
| types used in a graph. Similar to
| `config.modeBarButtonsToAdd` option. This may
| include "v1hovermode", "hoverclosest",
| "hovercompare", "togglehover",
| "togglespikelines", "drawline", "drawopenpath",
| "drawclosedpath", "drawcircle", "drawrect",
| "eraseshape".
| addsrc
| Sets the source reference on Chart Studio Cloud
| for `add`.
| bgcolor
| Sets the background color of the modebar.
| color
| Sets the color of the icons in the modebar.
| orientation
| Sets the orientation of the modebar.
| remove
| Determines which predefined modebar buttons to
| remove. Similar to
| `config.modeBarButtonsToRemove` option. This
| may include "autoScale2d", "autoscale",
| "editInChartStudio", "editinchartstudio",
| "hoverCompareCartesian", "hovercompare",
| "lasso", "lasso2d", "orbitRotation",
| "orbitrotation", "pan", "pan2d", "pan3d",
| "reset", "resetCameraDefault3d",
| "resetCameraLastSave3d", "resetGeo",
| "resetSankeyGroup", "resetScale2d",
| "resetViewMap", "resetViewMapbox",
| "resetViews", "resetcameradefault",
| "resetcameralastsave", "resetsankeygroup",
| "resetscale", "resetview", "resetviews",
| "select", "select2d", "sendDataToCloud",
| "senddatatocloud", "tableRotation",
| "tablerotation", "toImage", "toggleHover",
| "toggleSpikelines", "togglehover",
| "togglespikelines", "toimage", "zoom",
| "zoom2d", "zoom3d", "zoomIn2d", "zoomInGeo",
| "zoomInMap", "zoomInMapbox", "zoomOut2d",
| "zoomOutGeo", "zoomOutMap", "zoomOutMapbox",
| "zoomin", "zoomout".
| removesrc
| Sets the source reference on Chart Studio Cloud
| for `remove`.
| uirevision
| Controls persistence of user-driven changes
| related to the modebar, including `hovermode`,
| `dragmode`, and `showspikes` at both the root
| level and inside subplots. Defaults to
| `layout.uirevision`.
|
| Returns
| -------
| plotly.graph_objs.layout.Modebar
|
| newselection
| The 'newselection' property is an instance of Newselection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Newselection`
| - A dict of string/value properties that will be passed
| to the Newselection constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.layout.newselectio
| n.Line` instance or dict with compatible
| properties
| mode
| Describes how a new selection is created. If
| `immediate`, a new selection is created after
| first mouse up. If `gradual`, a new selection
| is not created after first mouse. By adding to
| and subtracting from the initial selection,
| this option allows declaring extra outlines of
| the selection.
|
| Returns
| -------
| plotly.graph_objs.layout.Newselection
|
| newshape
| The 'newshape' property is an instance of Newshape
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Newshape`
| - A dict of string/value properties that will be passed
| to the Newshape constructor
|
| Supported dict properties:
|
| drawdirection
| When `dragmode` is set to "drawrect",
| "drawline" or "drawcircle" this limits the drag
| to be horizontal, vertical or diagonal. Using
| "diagonal" there is no limit e.g. in drawing
| lines in any direction. "ortho" limits the draw
| to be either horizontal or vertical.
| "horizontal" allows horizontal extend.
| "vertical" allows vertical extend.
| fillcolor
| Sets the color filling new shapes' interior.
| Please note that if using a fillcolor with
| alpha greater than half, drag inside the active
| shape starts moving the shape underneath,
| otherwise a new shape could be started over.
| fillrule
| Determines the path's interior. For more info
| please visit https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.newshape.La
| bel` instance or dict with compatible
| properties
| layer
| Specifies whether new shapes are drawn below
| gridlines ("below"), between gridlines and
| traces ("between") or above traces ("above").
| legend
| Sets the reference to a legend to show new
| shape in. References to these legends are
| "legend", "legend2", "legend3", etc. Settings
| for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
| legendgroup
| Sets the legend group for new shape. Traces and
| shapes part of the same legend group hide/show
| at the same time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.newshape.Le
| gendgrouptitle` instance or dict with
| compatible properties
| legendrank
| Sets the legend rank for new shape. Items and
| groups with smaller ranks are presented on
| top/left side while with "reversed"
| `legend.traceorder` they are on bottom/right
| side. The default legendrank is 1000, so that
| you can use ranks less than 1000 to place
| certain items before all unranked items, and
| ranks greater than 1000 to go after all
| unranked items.
| legendwidth
| Sets the width (in px or fraction) of the
| legend for new shape.
| line
| :class:`plotly.graph_objects.layout.newshape.Li
| ne` instance or dict with compatible properties
| name
| Sets new shape name. The name appears as the
| legend item.
| opacity
| Sets the opacity of new shapes.
| showlegend
| Determines whether or not new shape is shown in
| the legend.
| visible
| Determines whether or not new shape is visible.
| If "legendonly", the shape is not drawn, but
| can appear as a legend item (provided that the
| legend itself is visible).
|
| Returns
| -------
| plotly.graph_objs.layout.Newshape
|
| paper_bgcolor
| Sets the background color of the paper where the graph is
| drawn.
|
| The 'paper_bgcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| piecolorway
| Sets the default pie slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendpiecolors`.
|
| The 'piecolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| plot_bgcolor
| Sets the background color of the plotting area in-between x and
| y axes.
|
| The 'plot_bgcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| polar
| The 'polar' property is an instance of Polar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Polar`
| - A dict of string/value properties that will be passed
| to the Polar constructor
|
| Supported dict properties:
|
| angularaxis
| :class:`plotly.graph_objects.layout.polar.Angul
| arAxis` instance or dict with compatible
| properties
| bargap
| Sets the gap between bars of adjacent location
| coordinates. Values are unitless, they
| represent fractions of the minimum difference
| in bar positions in the data.
| barmode
| Determines how bars at the same location
| coordinate are displayed on the graph. With
| "stack", the bars are stacked on top of one
| another With "overlay", the bars are plotted
| over one another, you might need to reduce
| "opacity" to see multiple bars.
| bgcolor
| Set the background color of the subplot
| domain
| :class:`plotly.graph_objects.layout.polar.Domai
| n` instance or dict with compatible properties
| gridshape
| Determines if the radial axis grid lines and
| angular axis line are drawn as "circular"
| sectors or as "linear" (polygon) sectors. Has
| an effect only when the angular axis has `type`
| "category". Note that `radialaxis.angle` is
| snapped to the angle of the closest vertex when
| `gridshape` is "circular" (so that radial axis
| scale is the same as the data scale).
| hole
| Sets the fraction of the radius to cut out of
| the polar subplot.
| radialaxis
| :class:`plotly.graph_objects.layout.polar.Radia
| lAxis` instance or dict with compatible
| properties
| sector
| Sets angular span of this polar subplot with
| two angles (in degrees). Sector are assumed to
| be spanned in the counterclockwise direction
| with 0 corresponding to rightmost limit of the
| polar subplot.
| uirevision
| Controls persistence of user-driven changes in
| axis attributes, if not overridden in the
| individual axes. Defaults to
| `layout.uirevision`.
|
| Returns
| -------
| plotly.graph_objs.layout.Polar
|
| scattergap
| Sets the gap (in plot fraction) between scatter points of
| adjacent location coordinates. Defaults to `bargap`.
|
| The 'scattergap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| scattermode
| Determines how scatter points at the same location coordinate
| are displayed on the graph. With "group", the scatter points
| are plotted next to one another centered around the shared
| location. With "overlay", the scatter points are plotted over
| one another, you might need to reduce "opacity" to see multiple
| scatter points.
|
| The 'scattermode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| scene
| The 'scene' property is an instance of Scene
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Scene`
| - A dict of string/value properties that will be passed
| to the Scene constructor
|
| Supported dict properties:
|
| annotations
| A tuple of :class:`plotly.graph_objects.layout.
| scene.Annotation` instances or dicts with
| compatible properties
| annotationdefaults
| When used in a template (as layout.template.lay
| out.scene.annotationdefaults), sets the default
| property values to use for elements of
| layout.scene.annotations
| aspectmode
| If "cube", this scene's axes are drawn as a
| cube, regardless of the axes' ranges. If
| "data", this scene's axes are drawn in
| proportion with the axes' ranges. If "manual",
| this scene's axes are drawn in proportion with
| the input of "aspectratio" (the default
| behavior if "aspectratio" is provided). If
| "auto", this scene's axes are drawn using the
| results of "data" except when one axis is more
| than four times the size of the two others,
| where in that case the results of "cube" are
| used.
| aspectratio
| Sets this scene's axis aspectratio.
| bgcolor
|
| camera
| :class:`plotly.graph_objects.layout.scene.Camer
| a` instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.scene.Domai
| n` instance or dict with compatible properties
| dragmode
| Determines the mode of drag interactions for
| this scene.
| hovermode
| Determines the mode of hover interactions for
| this scene.
| uirevision
| Controls persistence of user-driven changes in
| camera attributes. Defaults to
| `layout.uirevision`.
| xaxis
| :class:`plotly.graph_objects.layout.scene.XAxis
| ` instance or dict with compatible properties
| yaxis
| :class:`plotly.graph_objects.layout.scene.YAxis
| ` instance or dict with compatible properties
| zaxis
| :class:`plotly.graph_objects.layout.scene.ZAxis
| ` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.layout.Scene
|
| selectdirection
| When `dragmode` is set to "select", this limits the selection
| of the drag to horizontal, vertical or diagonal. "h" only
| allows horizontal selection, "v" only vertical, "d" only
| diagonal and "any" sets no limit.
|
| The 'selectdirection' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['h', 'v', 'd', 'any']
|
| Returns
| -------
| Any
|
| selectiondefaults
| When used in a template (as
| layout.template.layout.selectiondefaults), sets the default
| property values to use for elements of layout.selections
|
| The 'selectiondefaults' property is an instance of Selection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Selection`
| - A dict of string/value properties that will be passed
| to the Selection constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Selection
|
| selectionrevision
| Controls persistence of user-driven changes in selected points
| from all traces.
|
| The 'selectionrevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| selections
| The 'selections' property is a tuple of instances of
| Selection that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Selection
| - A list or tuple of dicts of string/value properties that
| will be passed to the Selection constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.layout.selection.L
| ine` instance or dict with compatible
| properties
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the selection.
| path
| For `type` "path" - a valid SVG path similar to
| `shapes.path` in data coordinates. Allowed
| segments are: M, L and Z.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| type
| Specifies the selection type to be drawn. If
| "rect", a rectangle is drawn linking
| (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`) and
| (`x0`,`y1`). If "path", draw a custom SVG path
| using `path`.
| x0
| Sets the selection's starting x position.
| x1
| Sets the selection's end x position.
| xref
| Sets the selection's x coordinate axis. If set
| to a x axis id (e.g. "x" or "x2"), the `x`
| position refers to a x coordinate. If set to
| "paper", the `x` position refers to the
| distance from the left of the plotting area in
| normalized coordinates where 0 (1) corresponds
| to the left (right). If set to a x axis ID
| followed by "domain" (separated by a space),
| the position behaves like for "paper", but
| refers to the distance in fractions of the
| domain length from the left of the domain of
| that axis: e.g., *x2 domain* refers to the
| domain of the second x axis and a x position
| of 0.5 refers to the point between the left and
| the right of the domain of the second x axis.
| y0
| Sets the selection's starting y position.
| y1
| Sets the selection's end y position.
| yref
| Sets the selection's x coordinate axis. If set
| to a y axis id (e.g. "y" or "y2"), the `y`
| position refers to a y coordinate. If set to
| "paper", the `y` position refers to the
| distance from the bottom of the plotting area
| in normalized coordinates where 0 (1)
| corresponds to the bottom (top). If set to a y
| axis ID followed by "domain" (separated by a
| space), the position behaves like for "paper",
| but refers to the distance in fractions of the
| domain length from the bottom of the domain of
| that axis: e.g., *y2 domain* refers to the
| domain of the second y axis and a y position
| of 0.5 refers to the point between the bottom
| and the top of the domain of the second y axis.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Selection]
|
| separators
| Sets the decimal and thousand separators. For example, *. *
| puts a '.' before decimals and a space between thousands. In
| English locales, dflt is ".," but other locales may alter this
| default.
|
| The 'separators' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| shapedefaults
| When used in a template (as
| layout.template.layout.shapedefaults), sets the default
| property values to use for elements of layout.shapes
|
| The 'shapedefaults' property is an instance of Shape
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Shape`
| - A dict of string/value properties that will be passed
| to the Shape constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Shape
|
| shapes
| The 'shapes' property is a tuple of instances of
| Shape that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Shape
| - A list or tuple of dicts of string/value properties that
| will be passed to the Shape constructor
|
| Supported dict properties:
|
| editable
| Determines whether the shape could be activated
| for edit or not. Has no effect when the older
| editable shapes mode is enabled via
| `config.editable` or
| `config.edits.shapePosition`.
| fillcolor
| Sets the color filling the shape's interior.
| Only applies to closed shapes.
| fillrule
| Determines which regions of complex paths
| constitute the interior. For more info please
| visit https://developer.mozilla.org/en-
| US/docs/Web/SVG/Attribute/fill-rule
| label
| :class:`plotly.graph_objects.layout.shape.Label
| ` instance or dict with compatible properties
| layer
| Specifies whether shapes are drawn below
| gridlines ("below"), between gridlines and
| traces ("between") or above traces ("above").
| legend
| Sets the reference to a legend to show this
| shape in. References to these legends are
| "legend", "legend2", "legend3", etc. Settings
| for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
| legendgroup
| Sets the legend group for this shape. Traces
| and shapes part of the same legend group
| hide/show at the same time when toggling legend
| items.
| legendgrouptitle
| :class:`plotly.graph_objects.layout.shape.Legen
| dgrouptitle` instance or dict with compatible
| properties
| legendrank
| Sets the legend rank for this shape. Items and
| groups with smaller ranks are presented on
| top/left side while with "reversed"
| `legend.traceorder` they are on bottom/right
| side. The default legendrank is 1000, so that
| you can use ranks less than 1000 to place
| certain items before all unranked items, and
| ranks greater than 1000 to go after all
| unranked items. When having unranked or equal
| rank items shapes would be displayed after
| traces i.e. according to their order in data
| and layout.
| legendwidth
| Sets the width (in px or fraction) of the
| legend for this shape.
| line
| :class:`plotly.graph_objects.layout.shape.Line`
| instance or dict with compatible properties
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| opacity
| Sets the opacity of the shape.
| path
| For `type` "path" - a valid SVG path with the
| pixel values replaced by data values in
| `xsizemode`/`ysizemode` being "scaled" and
| taken unmodified as pixels relative to
| `xanchor` and `yanchor` in case of "pixel" size
| mode. There are a few restrictions / quirks
| only absolute instructions, not relative. So
| the allowed segments are: M, L, H, V, Q, C, T,
| S, and Z arcs (A) are not allowed because
| radius rx and ry are relative. In the future we
| could consider supporting relative commands,
| but we would have to decide on how to handle
| date and log axes. Note that even as is, Q and
| C Bezier paths that are smooth on linear axes
| may not be smooth on log, and vice versa. no
| chained "polybezier" commands - specify the
| segment type for each one. On category axes,
| values are numbers scaled to the serial numbers
| of categories because using the categories
| themselves there would be no way to describe
| fractional positions On data axes: because
| space and T are both normal components of path
| strings, we can't use either to separate date
| from time parts. Therefore we'll use underscore
| for this purpose: 2015-02-21_13:45:56.789
| showlegend
| Determines whether or not this shape is shown
| in the legend.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| type
| Specifies the shape type to be drawn. If
| "line", a line is drawn from (`x0`,`y0`) to
| (`x1`,`y1`) with respect to the axes' sizing
| mode. If "circle", a circle is drawn from
| ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius
| (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2
| -`y0`)|) with respect to the axes' sizing mode.
| If "rect", a rectangle is drawn linking
| (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`),
| (`x0`,`y1`), (`x0`,`y0`) with respect to the
| axes' sizing mode. If "path", draw a custom SVG
| path using `path`. with respect to the axes'
| sizing mode.
| visible
| Determines whether or not this shape is
| visible. If "legendonly", the shape is not
| drawn, but can appear as a legend item
| (provided that the legend itself is visible).
| x0
| Sets the shape's starting x position. See
| `type` and `xsizemode` for more info.
| x0shift
| Shifts `x0` away from the center of the
| category when `xref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| x1
| Sets the shape's end x position. See `type` and
| `xsizemode` for more info.
| x1shift
| Shifts `x1` away from the center of the
| category when `xref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| xanchor
| Only relevant in conjunction with `xsizemode`
| set to "pixel". Specifies the anchor point on
| the x axis to which `x0`, `x1` and x
| coordinates within `path` are relative to. E.g.
| useful to attach a pixel sized shape to a
| certain data value. No effect when `xsizemode`
| not set to "pixel".
| xref
| Sets the shape's x coordinate axis. If set to a
| x axis id (e.g. "x" or "x2"), the `x` position
| refers to a x coordinate. If set to "paper",
| the `x` position refers to the distance from
| the left of the plotting area in normalized
| coordinates where 0 (1) corresponds to the left
| (right). If set to a x axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the left of the domain of that axis: e.g., *x2
| domain* refers to the domain of the second x
| axis and a x position of 0.5 refers to the
| point between the left and the right of the
| domain of the second x axis.
| xsizemode
| Sets the shapes's sizing mode along the x axis.
| If set to "scaled", `x0`, `x1` and x
| coordinates within `path` refer to data values
| on the x axis or a fraction of the plot area's
| width (`xref` set to "paper"). If set to
| "pixel", `xanchor` specifies the x position in
| terms of data or plot fraction but `x0`, `x1`
| and x coordinates within `path` are pixels
| relative to `xanchor`. This way, the shape can
| have a fixed width while maintaining a position
| relative to data or plot fraction.
| y0
| Sets the shape's starting y position. See
| `type` and `ysizemode` for more info.
| y0shift
| Shifts `y0` away from the center of the
| category when `yref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| y1
| Sets the shape's end y position. See `type` and
| `ysizemode` for more info.
| y1shift
| Shifts `y1` away from the center of the
| category when `yref` is a "category" or
| "multicategory" axis. -0.5 corresponds to the
| start of the category and 0.5 corresponds to
| the end of the category.
| yanchor
| Only relevant in conjunction with `ysizemode`
| set to "pixel". Specifies the anchor point on
| the y axis to which `y0`, `y1` and y
| coordinates within `path` are relative to. E.g.
| useful to attach a pixel sized shape to a
| certain data value. No effect when `ysizemode`
| not set to "pixel".
| yref
| Sets the shape's y coordinate axis. If set to a
| y axis id (e.g. "y" or "y2"), the `y` position
| refers to a y coordinate. If set to "paper",
| the `y` position refers to the distance from
| the bottom of the plotting area in normalized
| coordinates where 0 (1) corresponds to the
| bottom (top). If set to a y axis ID followed by
| "domain" (separated by a space), the position
| behaves like for "paper", but refers to the
| distance in fractions of the domain length from
| the bottom of the domain of that axis: e.g.,
| *y2 domain* refers to the domain of the second
| y axis and a y position of 0.5 refers to the
| point between the bottom and the top of the
| domain of the second y axis.
| ysizemode
| Sets the shapes's sizing mode along the y axis.
| If set to "scaled", `y0`, `y1` and y
| coordinates within `path` refer to data values
| on the y axis or a fraction of the plot area's
| height (`yref` set to "paper"). If set to
| "pixel", `yanchor` specifies the y position in
| terms of data or plot fraction but `y0`, `y1`
| and y coordinates within `path` are pixels
| relative to `yanchor`. This way, the shape can
| have a fixed height while maintaining a
| position relative to data or plot fraction.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Shape]
|
| showlegend
| Determines whether or not a legend is drawn. Default is `true`
| if there is a trace to show and any of these: a) Two or more
| traces would by default be shown in the legend. b) One pie
| trace is shown in the legend. c) One trace is explicitly given
| with `showlegend: true`.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sliderdefaults
| When used in a template (as
| layout.template.layout.sliderdefaults), sets the default
| property values to use for elements of layout.sliders
|
| The 'sliderdefaults' property is an instance of Slider
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Slider`
| - A dict of string/value properties that will be passed
| to the Slider constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Slider
|
| sliders
| The 'sliders' property is a tuple of instances of
| Slider that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Slider
| - A list or tuple of dicts of string/value properties that
| will be passed to the Slider constructor
|
| Supported dict properties:
|
| active
| Determines which button (by index starting from
| 0) is considered active.
| activebgcolor
| Sets the background color of the slider grip
| while dragging.
| bgcolor
| Sets the background color of the slider.
| bordercolor
| Sets the color of the border enclosing the
| slider.
| borderwidth
| Sets the width (in px) of the border enclosing
| the slider.
| currentvalue
| :class:`plotly.graph_objects.layout.slider.Curr
| entvalue` instance or dict with compatible
| properties
| font
| Sets the font of the slider step labels.
| len
| Sets the length of the slider This measure
| excludes the padding of both ends. That is, the
| slider's length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this slider length is set in
| units of plot "fraction" or in *pixels. Use
| `len` to set the value.
| minorticklen
| Sets the length in pixels of minor step tick
| marks
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| pad
| Set the padding of the slider component along
| each side.
| steps
| A tuple of :class:`plotly.graph_objects.layout.
| slider.Step` instances or dicts with compatible
| properties
| stepdefaults
| When used in a template (as
| layout.template.layout.slider.stepdefaults),
| sets the default property values to use for
| elements of layout.slider.steps
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| tickcolor
| Sets the color of the border enclosing the
| slider.
| ticklen
| Sets the length in pixels of step tick marks
| tickwidth
| Sets the tick width (in px).
| transition
| :class:`plotly.graph_objects.layout.slider.Tran
| sition` instance or dict with compatible
| properties
| visible
| Determines whether or not the slider is
| visible.
| x
| Sets the x position (in normalized coordinates)
| of the slider.
| xanchor
| Sets the slider's horizontal position anchor.
| This anchor binds the `x` position to the
| "left", "center" or "right" of the range
| selector.
| y
| Sets the y position (in normalized coordinates)
| of the slider.
| yanchor
| Sets the slider's vertical position anchor This
| anchor binds the `y` position to the "top",
| "middle" or "bottom" of the range selector.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Slider]
|
| smith
| The 'smith' property is an instance of Smith
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Smith`
| - A dict of string/value properties that will be passed
| to the Smith constructor
|
| Supported dict properties:
|
| bgcolor
| Set the background color of the subplot
| domain
| :class:`plotly.graph_objects.layout.smith.Domai
| n` instance or dict with compatible properties
| imaginaryaxis
| :class:`plotly.graph_objects.layout.smith.Imagi
| naryaxis` instance or dict with compatible
| properties
| realaxis
| :class:`plotly.graph_objects.layout.smith.Reala
| xis` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.layout.Smith
|
| spikedistance
| Sets the default distance (in pixels) to look for data to draw
| spikelines to (-1 means no cutoff, 0 means no looking for
| data). As with hoverdistance, distance does not apply to area-
| like objects. In addition, some objects can be hovered on but
| will not generate spikelines, such as scatter fills.
|
| The 'spikedistance' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [-1, 9223372036854775807]
|
| Returns
| -------
| int
|
| sunburstcolorway
| Sets the default sunburst slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendsunburstcolors`.
|
| The 'sunburstcolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| template
| Default attributes to be applied to the plot. This should be a
| dict with format: `{'layout': layoutTemplate, 'data':
| {trace_type: [traceTemplate, ...], ...}}` where
| `layoutTemplate` is a dict matching the structure of
| `figure.layout` and `traceTemplate` is a dict matching the
| structure of the trace with type `trace_type` (e.g. 'scatter').
| Alternatively, this may be specified as an instance of
| plotly.graph_objs.layout.Template. Trace templates are applied
| cyclically to traces of each type. Container arrays (eg
| `annotations`) have special handling: An object ending in
| `defaults` (eg `annotationdefaults`) is applied to each array
| item. But if an item has a `templateitemname` key we look in
| the template array for an item with matching `name` and apply
| that instead. If no matching `name` is found we mark the item
| invisible. Any named template item not referenced is appended
| to the end of the array, so this can be used to add a watermark
| annotation or a logo image, for example. To omit one of these
| items on the plot, make an item with matching
| `templateitemname` and `visible: false`.
|
| The 'template' property is an instance of Template
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Template`
| - A dict of string/value properties that will be passed
| to the Template constructor
|
| Supported dict properties:
|
| data
| :class:`plotly.graph_objects.layout.template.Da
| ta` instance or dict with compatible properties
| layout
| :class:`plotly.graph_objects.Layout` instance
| or dict with compatible properties
|
| - The name of a registered template where current registered templates
| are stored in the plotly.io.templates configuration object. The names
| of all registered templates can be retrieved with:
| >>> import plotly.io as pio
| >>> list(pio.templates) # doctest: +ELLIPSIS
| ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...]
|
| - A string containing multiple registered template names, joined on '+'
| characters (e.g. 'template1+template2'). In this case the resulting
| template is computed by merging together the collection of registered
| templates
|
| Returns
| -------
| plotly.graph_objs.layout.Template
|
| ternary
| The 'ternary' property is an instance of Ternary
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Ternary`
| - A dict of string/value properties that will be passed
| to the Ternary constructor
|
| Supported dict properties:
|
| aaxis
| :class:`plotly.graph_objects.layout.ternary.Aax
| is` instance or dict with compatible properties
| baxis
| :class:`plotly.graph_objects.layout.ternary.Bax
| is` instance or dict with compatible properties
| bgcolor
| Set the background color of the subplot
| caxis
| :class:`plotly.graph_objects.layout.ternary.Cax
| is` instance or dict with compatible properties
| domain
| :class:`plotly.graph_objects.layout.ternary.Dom
| ain` instance or dict with compatible
| properties
| sum
| The number each triplet should sum to, and the
| maximum range of each axis
| uirevision
| Controls persistence of user-driven changes in
| axis `min` and `title`, if not overridden in
| the individual axes. Defaults to
| `layout.uirevision`.
|
| Returns
| -------
| plotly.graph_objs.layout.Ternary
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| automargin
| Determines whether the title can automatically
| push the figure margins. If `yref='paper'` then
| the margin will expand to ensure that the title
| doesn’t overlap with the edges of the
| container. If `yref='container'` then the
| margins will ensure that the title doesn’t
| overlap with the plot area, tick labels, and
| axis titles. If `automargin=true` and the
| margins need to be expanded, then y will be set
| to a default 1 and yanchor will be set to an
| appropriate default to ensure that minimal
| margin space is needed. Note that when
| `yref='paper'`, only 1 or 0 are allowed y
| values. Invalid values will be reset to the
| default 1.
| font
| Sets the title font. Note that the title's font
| used to be customized by the now deprecated
| `titlefont` attribute.
| pad
| Sets the padding of the title. Each padding
| value only applies when the corresponding
| `xanchor`/`yanchor` value is set accordingly.
| E.g. for left padding to take effect, `xanchor`
| must be set to "left". The same rule applies if
| `xanchor`/`yanchor` is determined
| automatically. Padding is muted if the
| respective anchor value is "middle*/*center".
| subtitle
| :class:`plotly.graph_objects.layout.title.Subti
| tle` instance or dict with compatible
| properties
| text
| Sets the plot's title. Note that before the
| existence of `title.text`, the title's contents
| used to be defined as the `title` attribute
| itself. This behavior has been deprecated.
| x
| Sets the x position with respect to `xref` in
| normalized coordinates from 0 (left) to 1
| (right).
| xanchor
| Sets the title's horizontal alignment with
| respect to its x position. "left" means that
| the title starts at x, "right" means that the
| title ends at x and "center" means that the
| title's center is at x. "auto" divides `xref`
| by three and calculates the `xanchor` value
| automatically based on the value of `x`.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` in
| normalized coordinates from 0 (bottom) to 1
| (top). "auto" places the baseline of the title
| onto the vertical center of the top margin.
| yanchor
| Sets the title's vertical alignment with
| respect to its y position. "top" means that the
| title's cap line is at y, "bottom" means that
| the title's baseline is at y and "middle" means
| that the title's midline is at y. "auto"
| divides `yref` by three and calculates the
| `yanchor` value automatically based on the
| value of `y`.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.layout.Title
|
| titlefont
| Deprecated: Please use layout.title.font instead. Sets the
| title font. Note that the title's font used to be customized by
| the now deprecated `titlefont` attribute.
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.title.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
|
| transition
| Sets transition options used during Plotly.react updates.
|
| The 'transition' property is an instance of Transition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Transition`
| - A dict of string/value properties that will be passed
| to the Transition constructor
|
| Supported dict properties:
|
| duration
| The duration of the transition, in
| milliseconds. If equal to zero, updates are
| synchronous.
| easing
| The easing function used for the transition
| ordering
| Determines whether the figure's layout or
| traces smoothly transitions during updates that
| make both traces and layout change.
|
| Returns
| -------
| plotly.graph_objs.layout.Transition
|
| treemapcolorway
| Sets the default treemap slice colors. Defaults to the main
| `colorway` used for trace colors. If you specify a new list
| here it can still be extended with lighter and darker colors,
| see `extendtreemapcolors`.
|
| The 'treemapcolorway' property is a colorlist that may be specified
| as a tuple, list, one-dimensional numpy array, or pandas Series of valid
| color strings
|
| Returns
| -------
| list
|
| uirevision
| Used to allow user interactions with the plot to persist after
| `Plotly.react` calls that are unaware of these interactions. If
| `uirevision` is omitted, or if it is given and it changed from
| the previous `Plotly.react` call, the exact new figure is used.
| If `uirevision` is truthy and did NOT change, any attribute
| that has been affected by user interactions and did not receive
| a different value in the new figure will keep the interaction
| value. `layout.uirevision` attribute serves as the default for
| `uirevision` attributes in various sub-containers. For finer
| control you can set these sub-attributes directly. For example,
| if your app separately controls the data on the x and y axes
| you might set `xaxis.uirevision=*time*` and
| `yaxis.uirevision=*cost*`. Then if only the y data is changed,
| you can update `yaxis.uirevision=*quantity*` and the y axis
| range will reset but the x axis range will retain any user-
| driven zoom.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| uniformtext
| The 'uniformtext' property is an instance of Uniformtext
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Uniformtext`
| - A dict of string/value properties that will be passed
| to the Uniformtext constructor
|
| Supported dict properties:
|
| minsize
| Sets the minimum text size between traces of
| the same type.
| mode
| Determines how the font size for various text
| elements are uniformed between each trace type.
| If the computed text sizes were smaller than
| the minimum size defined by
| `uniformtext.minsize` using "hide" option hides
| the text; and using "show" option shows the
| text without further downscaling. Please note
| that if the size defined by `minsize` is
| greater than the font size defined by trace,
| then the `minsize` is used.
|
| Returns
| -------
| plotly.graph_objs.layout.Uniformtext
|
| updatemenudefaults
| When used in a template (as
| layout.template.layout.updatemenudefaults), sets the default
| property values to use for elements of layout.updatemenus
|
| The 'updatemenudefaults' property is an instance of Updatemenu
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.Updatemenu`
| - A dict of string/value properties that will be passed
| to the Updatemenu constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.layout.Updatemenu
|
| updatemenus
| The 'updatemenus' property is a tuple of instances of
| Updatemenu that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.layout.Updatemenu
| - A list or tuple of dicts of string/value properties that
| will be passed to the Updatemenu constructor
|
| Supported dict properties:
|
| active
| Determines which button (by index starting from
| 0) is considered active.
| bgcolor
| Sets the background color of the update menu
| buttons.
| bordercolor
| Sets the color of the border enclosing the
| update menu.
| borderwidth
| Sets the width (in px) of the border enclosing
| the update menu.
| buttons
| A tuple of :class:`plotly.graph_objects.layout.
| updatemenu.Button` instances or dicts with
| compatible properties
| buttondefaults
| When used in a template (as layout.template.lay
| out.updatemenu.buttondefaults), sets the
| default property values to use for elements of
| layout.updatemenu.buttons
| direction
| Determines the direction in which the buttons
| are laid out, whether in a dropdown menu or a
| row/column of buttons. For `left` and `up`, the
| buttons will still appear in left-to-right or
| top-to-bottom order respectively.
| font
| Sets the font of the update menu button text.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| pad
| Sets the padding around the buttons or dropdown
| menu.
| showactive
| Highlights active dropdown item or active
| button if true.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| type
| Determines whether the buttons are accessible
| via a dropdown menu or whether the buttons are
| stacked horizontally or vertically
| visible
| Determines whether or not the update menu is
| visible.
| x
| Sets the x position (in normalized coordinates)
| of the update menu.
| xanchor
| Sets the update menu's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the range
| selector.
| y
| Sets the y position (in normalized coordinates)
| of the update menu.
| yanchor
| Sets the update menu's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the range
| selector.
|
| Returns
| -------
| tuple[plotly.graph_objs.layout.Updatemenu]
|
| violingap
| Sets the gap (in plot fraction) between violins of adjacent
| location coordinates. Has no effect on traces that have "width"
| set.
|
| The 'violingap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| violingroupgap
| Sets the gap (in plot fraction) between violins of the same
| location coordinate. Has no effect on traces that have "width"
| set.
|
| The 'violingroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| violinmode
| Determines how violins at the same location coordinate are
| displayed on the graph. If "group", the violins are plotted
| next to one another centered around the shared location. If
| "overlay", the violins are plotted over one another, you might
| need to set "opacity" to see them multiple violins. Has no
| effect on traces that have "width" set.
|
| The 'violinmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| waterfallgap
| Sets the gap (in plot fraction) between bars of adjacent
| location coordinates.
|
| The 'waterfallgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| waterfallgroupgap
| Sets the gap (in plot fraction) between bars of the same
| location coordinate.
|
| The 'waterfallgroupgap' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| waterfallmode
| Determines how bars at the same location coordinate are
| displayed on the graph. With "group", the bars are plotted next
| to one another centered around the shared location. With
| "overlay", the bars are plotted over one another, you might
| need to reduce "opacity" to see multiple bars.
|
| The 'waterfallmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['group', 'overlay']
|
| Returns
| -------
| Any
|
| width
| Sets the plot's width (in px).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [10, inf]
|
| Returns
| -------
| int|float
|
| xaxis
| The 'xaxis' property is an instance of XAxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.XAxis`
| - A dict of string/value properties that will be passed
| to the XAxis constructor
|
| Supported dict properties:
|
| anchor
| If set to an opposite-letter axis id (e.g.
| `x2`, `y`), this axis is bound to the
| corresponding opposite-letter axis. If set to
| "free", this axis' position is determined by
| `position`.
| automargin
| Determines whether long tick labels
| automatically grow the figure margins.
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided and it has a value for both the lower
| and upper bound, `autorange` is set to False.
| Using "min" applies autorange only to set the
| minimum. Using "max" applies autorange only to
| set the maximum. Using *min reversed* applies
| autorange only to set the minimum on a reversed
| axis. Using *max reversed* applies autorange
| only to set the maximum on a reversed axis.
| Using "reversed" applies autorange on both ends
| and reverses the axis direction.
| autorangeoptions
| :class:`plotly.graph_objects.layout.xaxis.Autor
| angeoptions` instance or dict with compatible
| properties
| autotickangles
| When `tickangle` is set to "auto", it will be
| set to the first angle in this array that is
| large enough to prevent label overlap.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| calendar
| Sets the calendar system to use for `range` and
| `tick0` if this is a date axis. This does not
| set the calendar for interpreting data on this
| axis, that's specified in the trace or via the
| global `layout.calendar`
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`. Set
| `categoryorder` to *total ascending* or *total
| descending* if order should be determined by
| the numerical order of the values. Similarly,
| the order can be determined by the min, max,
| sum, mean, geometric mean or median of all the
| values.
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| constrain
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines how that
| happens: by increasing the "range", or by
| decreasing the "domain". Default is "domain"
| for axes containing image traces, "range"
| otherwise.
| constraintoward
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines which
| direction we push the originally specified plot
| area. Options are "left", "center" (default),
| and "right" for x axes, and "top", "middle"
| (default), and "bottom" for y axes.
| dividercolor
| Sets the color of the dividers Only has an
| effect on "multicategory" axes.
| dividerwidth
| Sets the width (in px) of the dividers Only has
| an effect on "multicategory" axes.
| domain
| Sets the domain of this axis (in plot
| fraction).
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the color of the grid lines.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the grid lines.
| hoverformat
| Sets the hover text formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| insiderange
| Could be used to set the desired inside range
| of this axis (excluding the labels) when
| `ticklabelposition` of the anchored axis has
| "inside". Not implemented for axes with `type`
| "log". This would be ignored when `range` is
| provided.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| layer
| Sets the layer on which this axis is displayed.
| If *above traces*, this axis is displayed above
| all the subplot's traces If *below traces*,
| this axis is displayed below all the subplot's
| traces, but above the grid lines. Useful when
| used together with scatter-like traces with
| `cliponaxis` set to False to show markers
| and/or text nodes above this axis.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| matches
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis will match the range of the
| corresponding axis in data-coordinates space.
| Moreover, matching axes share auto-range
| values, category lists and histogram auto-bins.
| Note that setting axes simultaneously in both a
| `scaleanchor` and a `matches` constraint is
| currently forbidden. Moreover, note that
| matching axes must have the same `type`.
| maxallowed
| Determines the maximum range of this axis.
| minallowed
| Determines the minimum range of this axis.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| minor
| :class:`plotly.graph_objects.layout.xaxis.Minor
| ` instance or dict with compatible properties
| mirror
| Determines if the axis lines or/and ticks are
| mirrored to the opposite side of the plotting
| area. If True, the axis lines are mirrored. If
| "ticks", the axis lines and ticks are mirrored.
| If False, mirroring is disable. If "all", axis
| lines are mirrored on all shared-axes subplots.
| If "allticks", axis lines and ticks are
| mirrored on all shared-axes subplots.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| overlaying
| If set a same-letter axis id, this axis is
| overlaid on top of the corresponding same-
| letter axis, with traces and axes visible for
| both axes. If False, this axis does not overlay
| any same-letter axes. In this case, for axes
| with overlapping domains only the highest-
| numbered axis will be visible.
| position
| Sets the position of this axis in the plotting
| space (in normalized coordinates). Only has an
| effect if `anchor` is set to "free".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears. Leaving either or both
| elements `null` impacts the default
| `autorange`.
| rangebreaks
| A tuple of :class:`plotly.graph_objects.layout.
| xaxis.Rangebreak` instances or dicts with
| compatible properties
| rangebreakdefaults
| When used in a template (as layout.template.lay
| out.xaxis.rangebreakdefaults), sets the default
| property values to use for elements of
| layout.xaxis.rangebreaks
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data. Applies
| only to linear axes.
| rangeselector
| :class:`plotly.graph_objects.layout.xaxis.Range
| selector` instance or dict with compatible
| properties
| rangeslider
| :class:`plotly.graph_objects.layout.xaxis.Range
| slider` instance or dict with compatible
| properties
| scaleanchor
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis changes together with the
| range of the corresponding axis such that the
| scale of pixels per unit is in a constant
| ratio. Both axes are still zoomable, but when
| you zoom one, the other will zoom the same
| amount, keeping a fixed midpoint. `constrain`
| and `constraintoward` determine how we enforce
| the constraint. You can chain these, ie `yaxis:
| {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}`
| but you can only link axes of the same `type`.
| The linked axis can have the opposite letter
| (to constrain the aspect ratio) or the same
| letter (to match scales across subplots). Loops
| (`yaxis: {scaleanchor: *x*}, xaxis:
| {scaleanchor: *y*}` or longer) are redundant
| and the last constraint encountered will be
| ignored to avoid possible inconsistent
| constraints via `scaleratio`. Note that setting
| axes simultaneously in both a `scaleanchor` and
| a `matches` constraint is currently forbidden.
| Setting `false` allows to remove a default
| constraint (occasionally, you may need to
| prevent a default `scaleanchor` constraint from
| being applied, eg. when having an image trace
| `yaxis: {scaleanchor: "x"}` is set
| automatically in order for pixels to be
| rendered as squares, setting `yaxis:
| {scaleanchor: false}` allows to remove the
| constraint).
| scaleratio
| If this axis is linked to another by
| `scaleanchor`, this determines the pixel to
| unit scale ratio. For example, if this value is
| 10, then every unit on this axis spans 10 times
| the number of pixels as a unit on the linked
| axis. Use this for example to create an
| elevation profile where the vertical scale is
| exaggerated a fixed amount with respect to the
| horizontal.
| separatethousands
| If "true", even 4-digit integers are separated
| showdividers
| Determines whether or not a dividers are drawn
| between the category levels of this axis. Only
| has an effect on "multicategory" axes.
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showspikes
| Determines whether or not spikes (aka
| droplines) are drawn for this axis. Note: This
| only takes affect when hovermode = closest
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| side
| Determines whether a x (y) axis is positioned
| at the "bottom" ("left") or "top" ("right") of
| the plotting area.
| spikecolor
| Sets the spike color. If undefined, will use
| the series color
| spikedash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| spikemode
| Determines the drawing mode for the spike line
| If "toaxis", the line is drawn from the data
| point to the axis the series is plotted on. If
| "across", the line is drawn across the entire
| plot area, and supercedes "toaxis". If
| "marker", then a marker dot is drawn on the
| axis the series is plotted on
| spikesnap
| Determines whether spikelines are stuck to the
| cursor or to the closest datapoints.
| spikethickness
| Sets the width (in px) of the zero line.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.layout.
| xaxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.lay
| out.xaxis.tickformatstopdefaults), sets the
| default property values to use for elements of
| layout.xaxis.tickformatstops
| ticklabelindex
| Only for axes with `type` "date" or "linear".
| Instead of drawing the major tick label, draw
| the label for the minor tick that is n
| positions away from the major tick. E.g. to
| always draw the label for the minor tick before
| each major tick, choose `ticklabelindex` -1.
| This is useful for date axes with
| `ticklabelmode` "period" if you want to label
| the period that ends with each major tick
| instead of the period that begins there.
| ticklabelindexsrc
| Sets the source reference on Chart Studio Cloud
| for `ticklabelindex`.
| ticklabelmode
| Determines where tick labels are drawn with
| respect to their corresponding ticks and grid
| lines. Only has an effect for axes of `type`
| "date" When set to "period", tick labels are
| drawn in the middle of the period between
| ticks.
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. Otherwise on
| "category" and "multicategory" axes the default
| is "allow". In other cases the default is *hide
| past div*.
| ticklabelposition
| Determines where tick labels are drawn with
| respect to the axis Please note that top or
| bottom has no effect on x axes or when
| `ticklabelmode` is set to "period". Similarly
| left or right has no effect on y axes or when
| `ticklabelmode` is set to "period". Has no
| effect on "multicategory" axes or when
| `tickson` is set to "boundaries". When used on
| axes linked by `matches` or `scaleanchor`, no
| extra padding for inside labels would be added
| by autorange, so that the scales could match.
| ticklabelshift
| Shifts the tick labels by the specified number
| of pixels in parallel to the axis. Positive
| values move the labels in the positive
| direction of the axis.
| ticklabelstandoff
| Sets the standoff distance (in px) between the
| axis tick labels and their default position. A
| positive `ticklabelstandoff` moves the labels
| farther away from the plot area if
| `ticklabelposition` is "outside", and deeper
| into the plot area if `ticklabelposition` is
| "inside". A negative `ticklabelstandoff` works
| in the opposite direction, moving outside ticks
| towards the plot area and inside ticks towards
| the outside. If the negative value is large
| enough, inside ticks can even end up outside
| and vice versa.
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided). If "sync", the number of ticks will
| sync with the overlayed axis set by
| `overlaying` property.
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| tickson
| Determines where ticks and grid lines are drawn
| with respect to their corresponding tick
| labels. Only has an effect for axes of `type`
| "category" or "multicategory". When set to
| "boundaries", ticks and grid lines are drawn
| half a category to the left/bottom of labels.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.layout.xaxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.xaxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be customized by the
| now deprecated `titlefont` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
| uirevision
| Controls persistence of user-driven changes in
| axis `range`, `autorange`, and `title` if in
| `editable: true` configuration. Defaults to
| `layout.uirevision`.
| visible
| A single toggle to hide the axis while
| preserving interaction like dragging. Default
| is true when a cheater plot is present on the
| axis, otherwise false
| zeroline
| Determines whether or not a line is drawn at
| along the 0 value of this axis. If True, the
| zero line is drawn on top of the grid lines.
| zerolinecolor
| Sets the line color of the zero line.
| zerolinewidth
| Sets the width (in px) of the zero line.
|
| Returns
| -------
| plotly.graph_objs.layout.XAxis
|
| yaxis
| The 'yaxis' property is an instance of YAxis
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.layout.YAxis`
| - A dict of string/value properties that will be passed
| to the YAxis constructor
|
| Supported dict properties:
|
| anchor
| If set to an opposite-letter axis id (e.g.
| `x2`, `y`), this axis is bound to the
| corresponding opposite-letter axis. If set to
| "free", this axis' position is determined by
| `position`.
| automargin
| Determines whether long tick labels
| automatically grow the figure margins.
| autorange
| Determines whether or not the range of this
| axis is computed in relation to the input data.
| See `rangemode` for more info. If `range` is
| provided and it has a value for both the lower
| and upper bound, `autorange` is set to False.
| Using "min" applies autorange only to set the
| minimum. Using "max" applies autorange only to
| set the maximum. Using *min reversed* applies
| autorange only to set the minimum on a reversed
| axis. Using *max reversed* applies autorange
| only to set the maximum on a reversed axis.
| Using "reversed" applies autorange on both ends
| and reverses the axis direction.
| autorangeoptions
| :class:`plotly.graph_objects.layout.yaxis.Autor
| angeoptions` instance or dict with compatible
| properties
| autoshift
| Automatically reposition the axis to avoid
| overlap with other axes with the same
| `overlaying` value. This repositioning will
| account for any `shift` amount applied to other
| axes on the same side with `autoshift` is set
| to true. Only has an effect if `anchor` is set
| to "free".
| autotickangles
| When `tickangle` is set to "auto", it will be
| set to the first angle in this array that is
| large enough to prevent label overlap.
| autotypenumbers
| Using "strict" a numeric string in trace data
| is not converted to a number. Using *convert
| types* a numeric string in trace data may be
| treated as a number during automatic axis
| `type` detection. Defaults to
| layout.autotypenumbers.
| calendar
| Sets the calendar system to use for `range` and
| `tick0` if this is a date axis. This does not
| set the calendar for interpreting data on this
| axis, that's specified in the trace or via the
| global `layout.calendar`
| categoryarray
| Sets the order in which categories on this axis
| appear. Only has an effect if `categoryorder`
| is set to "array". Used with `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the case of
| categorical variables. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`. Set
| `categoryorder` to *total ascending* or *total
| descending* if order should be determined by
| the numerical order of the values. Similarly,
| the order can be determined by the min, max,
| sum, mean, geometric mean or median of all the
| values.
| color
| Sets default for all colors associated with
| this axis all at once: line, font, tick, and
| grid colors. Grid color is lightened by
| blending this with the plot background
| Individual pieces can override this.
| constrain
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines how that
| happens: by increasing the "range", or by
| decreasing the "domain". Default is "domain"
| for axes containing image traces, "range"
| otherwise.
| constraintoward
| If this axis needs to be compressed (either due
| to its own `scaleanchor` and `scaleratio` or
| those of the other axis), determines which
| direction we push the originally specified plot
| area. Options are "left", "center" (default),
| and "right" for x axes, and "top", "middle"
| (default), and "bottom" for y axes.
| dividercolor
| Sets the color of the dividers Only has an
| effect on "multicategory" axes.
| dividerwidth
| Sets the width (in px) of the dividers Only has
| an effect on "multicategory" axes.
| domain
| Sets the domain of this axis (in plot
| fraction).
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| fixedrange
| Determines whether or not this axis is zoom-
| able. If true, then zoom is disabled.
| gridcolor
| Sets the color of the grid lines.
| griddash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| gridwidth
| Sets the width (in px) of the grid lines.
| hoverformat
| Sets the hover text formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| insiderange
| Could be used to set the desired inside range
| of this axis (excluding the labels) when
| `ticklabelposition` of the anchored axis has
| "inside". Not implemented for axes with `type`
| "log". This would be ignored when `range` is
| provided.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| layer
| Sets the layer on which this axis is displayed.
| If *above traces*, this axis is displayed above
| all the subplot's traces If *below traces*,
| this axis is displayed below all the subplot's
| traces, but above the grid lines. Useful when
| used together with scatter-like traces with
| `cliponaxis` set to False to show markers
| and/or text nodes above this axis.
| linecolor
| Sets the axis line color.
| linewidth
| Sets the width (in px) of the axis line.
| matches
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis will match the range of the
| corresponding axis in data-coordinates space.
| Moreover, matching axes share auto-range
| values, category lists and histogram auto-bins.
| Note that setting axes simultaneously in both a
| `scaleanchor` and a `matches` constraint is
| currently forbidden. Moreover, note that
| matching axes must have the same `type`.
| maxallowed
| Determines the maximum range of this axis.
| minallowed
| Determines the minimum range of this axis.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| minor
| :class:`plotly.graph_objects.layout.yaxis.Minor
| ` instance or dict with compatible properties
| mirror
| Determines if the axis lines or/and ticks are
| mirrored to the opposite side of the plotting
| area. If True, the axis lines are mirrored. If
| "ticks", the axis lines and ticks are mirrored.
| If False, mirroring is disable. If "all", axis
| lines are mirrored on all shared-axes subplots.
| If "allticks", axis lines and ticks are
| mirrored on all shared-axes subplots.
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| overlaying
| If set a same-letter axis id, this axis is
| overlaid on top of the corresponding same-
| letter axis, with traces and axes visible for
| both axes. If False, this axis does not overlay
| any same-letter axes. In this case, for axes
| with overlapping domains only the highest-
| numbered axis will be visible.
| position
| Sets the position of this axis in the plotting
| space (in normalized coordinates). Only has an
| effect if `anchor` is set to "free".
| range
| Sets the range of this axis. If the axis `type`
| is "log", then you must take the log of your
| desired range (e.g. to set the range from 1 to
| 100, set the range from 0 to 2). If the axis
| `type` is "date", it should be date strings,
| like date data, though Date objects and unix
| milliseconds will be accepted and converted to
| strings. If the axis `type` is "category", it
| should be numbers, using the scale where each
| category is assigned a serial number from zero
| in the order it appears. Leaving either or both
| elements `null` impacts the default
| `autorange`.
| rangebreaks
| A tuple of :class:`plotly.graph_objects.layout.
| yaxis.Rangebreak` instances or dicts with
| compatible properties
| rangebreakdefaults
| When used in a template (as layout.template.lay
| out.yaxis.rangebreakdefaults), sets the default
| property values to use for elements of
| layout.yaxis.rangebreaks
| rangemode
| If "normal", the range is computed in relation
| to the extrema of the input data. If *tozero*`,
| the range extends to 0, regardless of the input
| data If "nonnegative", the range is non-
| negative, regardless of the input data. Applies
| only to linear axes.
| scaleanchor
| If set to another axis id (e.g. `x2`, `y`), the
| range of this axis changes together with the
| range of the corresponding axis such that the
| scale of pixels per unit is in a constant
| ratio. Both axes are still zoomable, but when
| you zoom one, the other will zoom the same
| amount, keeping a fixed midpoint. `constrain`
| and `constraintoward` determine how we enforce
| the constraint. You can chain these, ie `yaxis:
| {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}`
| but you can only link axes of the same `type`.
| The linked axis can have the opposite letter
| (to constrain the aspect ratio) or the same
| letter (to match scales across subplots). Loops
| (`yaxis: {scaleanchor: *x*}, xaxis:
| {scaleanchor: *y*}` or longer) are redundant
| and the last constraint encountered will be
| ignored to avoid possible inconsistent
| constraints via `scaleratio`. Note that setting
| axes simultaneously in both a `scaleanchor` and
| a `matches` constraint is currently forbidden.
| Setting `false` allows to remove a default
| constraint (occasionally, you may need to
| prevent a default `scaleanchor` constraint from
| being applied, eg. when having an image trace
| `yaxis: {scaleanchor: "x"}` is set
| automatically in order for pixels to be
| rendered as squares, setting `yaxis:
| {scaleanchor: false}` allows to remove the
| constraint).
| scaleratio
| If this axis is linked to another by
| `scaleanchor`, this determines the pixel to
| unit scale ratio. For example, if this value is
| 10, then every unit on this axis spans 10 times
| the number of pixels as a unit on the linked
| axis. Use this for example to create an
| elevation profile where the vertical scale is
| exaggerated a fixed amount with respect to the
| horizontal.
| separatethousands
| If "true", even 4-digit integers are separated
| shift
| Moves the axis a given number of pixels from
| where it would have been otherwise. Accepts
| both positive and negative values, which will
| shift the axis either right or left,
| respectively. If `autoshift` is set to true,
| then this defaults to a padding of -3 if `side`
| is set to "left". and defaults to +3 if `side`
| is set to "right". Defaults to 0 if `autoshift`
| is set to false. Only has an effect if `anchor`
| is set to "free".
| showdividers
| Determines whether or not a dividers are drawn
| between the category levels of this axis. Only
| has an effect on "multicategory" axes.
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showgrid
| Determines whether or not grid lines are drawn.
| If True, the grid lines are drawn at every tick
| mark.
| showline
| Determines whether or not a line bounding this
| axis is drawn.
| showspikes
| Determines whether or not spikes (aka
| droplines) are drawn for this axis. Note: This
| only takes affect when hovermode = closest
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| side
| Determines whether a x (y) axis is positioned
| at the "bottom" ("left") or "top" ("right") of
| the plotting area.
| spikecolor
| Sets the spike color. If undefined, will use
| the series color
| spikedash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| spikemode
| Determines the drawing mode for the spike line
| If "toaxis", the line is drawn from the data
| point to the axis the series is plotted on. If
| "across", the line is drawn across the entire
| plot area, and supercedes "toaxis". If
| "marker", then a marker dot is drawn on the
| axis the series is plotted on
| spikesnap
| Determines whether spikelines are stuck to the
| cursor or to the closest datapoints.
| spikethickness
| Sets the width (in px) of the zero line.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the tick font.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.layout.
| yaxis.Tickformatstop` instances or dicts with
| compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.lay
| out.yaxis.tickformatstopdefaults), sets the
| default property values to use for elements of
| layout.yaxis.tickformatstops
| ticklabelindex
| Only for axes with `type` "date" or "linear".
| Instead of drawing the major tick label, draw
| the label for the minor tick that is n
| positions away from the major tick. E.g. to
| always draw the label for the minor tick before
| each major tick, choose `ticklabelindex` -1.
| This is useful for date axes with
| `ticklabelmode` "period" if you want to label
| the period that ends with each major tick
| instead of the period that begins there.
| ticklabelindexsrc
| Sets the source reference on Chart Studio Cloud
| for `ticklabelindex`.
| ticklabelmode
| Determines where tick labels are drawn with
| respect to their corresponding ticks and grid
| lines. Only has an effect for axes of `type`
| "date" When set to "period", tick labels are
| drawn in the middle of the period between
| ticks.
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. Otherwise on
| "category" and "multicategory" axes the default
| is "allow". In other cases the default is *hide
| past div*.
| ticklabelposition
| Determines where tick labels are drawn with
| respect to the axis Please note that top or
| bottom has no effect on x axes or when
| `ticklabelmode` is set to "period". Similarly
| left or right has no effect on y axes or when
| `ticklabelmode` is set to "period". Has no
| effect on "multicategory" axes or when
| `tickson` is set to "boundaries". When used on
| axes linked by `matches` or `scaleanchor`, no
| extra padding for inside labels would be added
| by autorange, so that the scales could match.
| ticklabelshift
| Shifts the tick labels by the specified number
| of pixels in parallel to the axis. Positive
| values move the labels in the positive
| direction of the axis.
| ticklabelstandoff
| Sets the standoff distance (in px) between the
| axis tick labels and their default position. A
| positive `ticklabelstandoff` moves the labels
| farther away from the plot area if
| `ticklabelposition` is "outside", and deeper
| into the plot area if `ticklabelposition` is
| "inside". A negative `ticklabelstandoff` works
| in the opposite direction, moving outside ticks
| towards the plot area and inside ticks towards
| the outside. If the negative value is large
| enough, inside ticks can even end up outside
| and vice versa.
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided). If "sync", the number of ticks will
| sync with the overlayed axis set by
| `overlaying` property.
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| tickson
| Determines where ticks and grid lines are drawn
| with respect to their corresponding tick
| labels. Only has an effect for axes of `type`
| "category" or "multicategory". When set to
| "boundaries", ticks and grid lines are drawn
| half a category to the left/bottom of labels.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.layout.yaxis.Title
| ` instance or dict with compatible properties
| titlefont
| Deprecated: Please use layout.yaxis.title.font
| instead. Sets this axis' title font. Note that
| the title's font used to be customized by the
| now deprecated `titlefont` attribute.
| type
| Sets the axis type. By default, plotly attempts
| to determined the axis type by looking into the
| data of the traces that referenced the axis in
| question.
| uirevision
| Controls persistence of user-driven changes in
| axis `range`, `autorange`, and `title` if in
| `editable: true` configuration. Defaults to
| `layout.uirevision`.
| visible
| A single toggle to hide the axis while
| preserving interaction like dragging. Default
| is true when a cheater plot is present on the
| axis, otherwise false
| zeroline
| Determines whether or not a line is drawn at
| along the 0 value of this axis. If True, the
| zero line is drawn on top of the grid lines.
| zerolinecolor
| Sets the line color of the zero line.
| zerolinewidth
| Sets the width (in px) of the zero line.
|
| Returns
| -------
| plotly.graph_objs.layout.YAxis
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| re = <module 're' from 'C:\\Users\\Youse\\AppData\\Lo...ograms\\Python...
| Support for regular expressions (RE).
|
| This module provides regular expression matching operations similar to
| those found in Perl. It supports both 8-bit and Unicode strings; both
| the pattern and the strings being processed can contain null bytes and
| characters outside the US ASCII range.
|
| Regular expressions can contain both special and ordinary characters.
| Most ordinary characters, like "A", "a", or "0", are the simplest
| regular expressions; they simply match themselves. You can
| concatenate ordinary characters, so last matches the string 'last'.
|
| The special characters are:
| "." Matches any character except a newline.
| "^" Matches the start of the string.
| "$" Matches the end of the string or just before the newline at
| the end of the string.
| "*" Matches 0 or more (greedy) repetitions of the preceding RE.
| Greedy means that it will match as many repetitions as possible.
| "+" Matches 1 or more (greedy) repetitions of the preceding RE.
| "?" Matches 0 or 1 (greedy) of the preceding RE.
| *?,+?,?? Non-greedy versions of the previous three special characters.
| {m,n} Matches from m to n repetitions of the preceding RE.
| {m,n}? Non-greedy version of the above.
| "\\" Either escapes special characters or signals a special sequence.
| [] Indicates a set of characters.
| A "^" as the first character indicates a complementing set.
| "|" A|B, creates an RE that will match either A or B.
| (...) Matches the RE inside the parentheses.
| The contents can be retrieved or matched later in the string.
| (?aiLmsux) The letters set the corresponding flags defined below.
| (?:...) Non-grouping version of regular parentheses.
| (?P<name>...) The substring matched by the group is accessible by name.
| (?P=name) Matches the text matched earlier by the group named name.
| (?#...) A comment; ignored.
| (?=...) Matches if ... matches next, but doesn't consume the string.
| (?!...) Matches if ... doesn't match next.
| (?<=...) Matches if preceded by ... (must be fixed length).
| (?<!...) Matches if not preceded by ... (must be fixed length).
| (?(id/name)yes|no) Matches yes pattern if the group with id/name matched,
| the (optional) no pattern otherwise.
|
| The special sequences consist of "\\" and a character from the list
| below. If the ordinary character is not on the list, then the
| resulting RE will match the second character.
| \number Matches the contents of the group of the same number.
| \A Matches only at the start of the string.
| \Z Matches only at the end of the string.
| \b Matches the empty string, but only at the start or end of a word.
| \B Matches the empty string, but not at the start or end of a word.
| \d Matches any decimal digit; equivalent to the set [0-9] in
| bytes patterns or string patterns with the ASCII flag.
| In string patterns without the ASCII flag, it will match the whole
| range of Unicode digits.
| \D Matches any non-digit character; equivalent to [^\d].
| \s Matches any whitespace character; equivalent to [ \t\n\r\f\v] in
| bytes patterns or string patterns with the ASCII flag.
| In string patterns without the ASCII flag, it will match the whole
| range of Unicode whitespace characters.
| \S Matches any non-whitespace character; equivalent to [^\s].
| \w Matches any alphanumeric character; equivalent to [a-zA-Z0-9_]
| in bytes patterns or string patterns with the ASCII flag.
| In string patterns without the ASCII flag, it will match the
| range of Unicode alphanumeric characters (letters plus digits
| plus underscore).
| With LOCALE, it will match the set [0-9_] plus characters defined
| as letters for the current locale.
| \W Matches the complement of \w.
| \\ Matches a literal backslash.
|
| This module exports the following functions:
| match Match a regular expression pattern to the beginning of a string.
| fullmatch Match a regular expression pattern to all of a string.
| search Search a string for the presence of a pattern.
| sub Substitute occurrences of a pattern found in a string.
| subn Same as sub, but also return the number of substitutions made.
| split Split a string by the occurrences of a pattern.
| findall Find all occurrences of a pattern in a string.
| finditer Return an iterator yielding a Match object for each match.
| compile Compile a pattern into a Pattern object.
| purge Clear the regular expression cache.
| escape Backslash all non-alphanumerics in a string.
|
| Each function other than purge and escape can take an optional 'flags' argument
| consisting of one or more of the following module constants, joined by "|".
| A, L, and U are mutually exclusive.
| A ASCII For string patterns, make \w, \W, \b, \B, \d, \D
| match the corresponding ASCII character categories
| (rather than the whole Unicode categories, which is the
| default).
| For bytes patterns, this flag is the only available
| behaviour and needn't be specified.
| I IGNORECASE Perform case-insensitive matching.
| L LOCALE Make \w, \W, \b, \B, dependent on the current locale.
| M MULTILINE "^" matches the beginning of lines (after a newline)
| as well as the string.
| "$" matches the end of lines (before a newline) as well
| as the end of the string.
| S DOTALL "." matches any character at all, including the newline.
| X VERBOSE Ignore whitespace and comments for nicer looking RE's.
| U UNICODE For compatibility only. Ignored for string patterns (it
| is the default), and forbidden for bytes patterns.
|
| This module also defines an exception 'error'.
|
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseLayoutType:
|
| __contains__(self, prop)
| Custom __contains__ that handles dynamic subplot properties
|
| __dir__(self)
| Custom __dir__ that handles dynamic subplot properties
|
| __getattr__(self, prop)
| Custom __getattr__ that handles dynamic subplot properties
|
| __getitem__(self, prop)
| Custom __getitem__ that handles dynamic subplot properties
|
| __setattr__(self, prop, value)
| Custom __setattr__ that handles dynamic subplot properties
|
| __setitem__(self, prop, value)
| Custom __setitem__ that handles dynamic subplot properties
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object representation when displayed in the
| terminal/notebook
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Legend(builtins.dict)
| Legend(*args, **kwargs)
|
| plotly.graph_objs.Legend is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Legend
|
| Method resolution order:
| Legend
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Legend is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Legend
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Line(builtins.dict)
| Line(*args, **kwargs)
|
| plotly.graph_objs.Line is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Line
| - plotly.graph_objs.layout.shape.Line
| - etc.
|
| Method resolution order:
| Line
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Line is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Line
| - plotly.graph_objs.layout.shape.Line
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Margin(builtins.dict)
| Margin(*args, **kwargs)
|
| plotly.graph_objs.Margin is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Margin
|
| Method resolution order:
| Margin
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Margin is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Margin
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Marker(builtins.dict)
| Marker(*args, **kwargs)
|
| plotly.graph_objs.Marker is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Marker
| - plotly.graph_objs.histogram.selected.Marker
| - etc.
|
| Method resolution order:
| Marker
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Marker is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Marker
| - plotly.graph_objs.histogram.selected.Marker
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Mesh3d(plotly.basedatatypes.BaseTraceType)
| Mesh3d(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Mesh3d
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Mesh3d object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Mesh3d`
| alphahull
| Determines how the mesh surface triangles are derived
| from the set of vertices (points) represented by the
| `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays
| are not supplied. For general use of `mesh3d` it is
| preferred that `i`, `j`, `k` are supplied. If "-1",
| Delaunay triangulation is used, which is mainly
| suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In
| case the `delaunayaxis` intersects the mesh surface at
| more than one point it will result triangles that are
| very long in the dimension of `delaunayaxis`. If ">0",
| the alpha-shape algorithm is used. In this case, the
| positive `alphahull` value signals the use of the
| alpha-shape algorithm, _and_ its value acts as the
| parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or
| if the intention is to enclose the `x`, `y` and `z`
| point set into a convex hull.
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `intensity`) or
| the bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `intensity`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `intensity` and if set, `cmax`
| must be set as well.
| color
| Sets the color of the whole mesh
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.mesh3d.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.mesh3d.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is
| perpendicular to the surface of the Delaunay
| triangulation. It has an effect if `i`, `j`, `k` are
| not provided and `alphahull` is set to indicate
| Delaunay triangulation.
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.mesh3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| i
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "first" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `i[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `i` represents a point in space, which
| is the first vertex of a triangle.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| intensity
| Sets the intensity values for vertices or cells as
| defined by `intensitymode`. It can be used for plotting
| fields on meshes.
| intensitymode
| Determines the source of `intensity` values.
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
| isrc
| Sets the source reference on Chart Studio Cloud for
| `i`.
| j
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "second" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `j[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `j` represents a point in space, which
| is the second vertex of a triangle.
| jsrc
| Sets the source reference on Chart Studio Cloud for
| `j`.
| k
| A vector of vertex indices, i.e. integer values between
| 0 and the length of the vertex vectors, representing
| the "third" vertex of a triangle. For example, `{i[m],
| j[m], k[m]}` together represent face m (triangle m) in
| the mesh, where `k[m] = n` points to the triplet
| `{x[n], y[n], z[n]}` in the vertex arrays. Therefore,
| each element in `k` represents a point in space, which
| is the third vertex of a triangle.
| ksrc
| Sets the source reference on Chart Studio Cloud for
| `k`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.mesh3d.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.mesh3d.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.mesh3d.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.mesh3d.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| vertexcolor
| Sets the color of each vertex Overrides "color". While
| Red, green and blue colors are in the range of 0 and
| 255; in the case of having vertex color data in RGBA
| format, the alpha color should be normalized to be
| between 0 and 1.
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices. The nth element
| of vectors `x`, `y` and `z` jointly represent the X, Y
| and Z coordinates of the nth vertex.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Mesh3d
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alphahull
| Determines how the mesh surface triangles are derived from the
| set of vertices (points) represented by the `x`, `y` and `z`
| arrays, if the `i`, `j`, `k` arrays are not supplied. For
| general use of `mesh3d` it is preferred that `i`, `j`, `k` are
| supplied. If "-1", Delaunay triangulation is used, which is
| mainly suitable if the mesh is a single, more or less layer
| surface that is perpendicular to `delaunayaxis`. In case the
| `delaunayaxis` intersects the mesh surface at more than one
| point it will result triangles that are very long in the
| dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm
| is used. In this case, the positive `alphahull` value signals
| the use of the alpha-shape algorithm, _and_ its value acts as
| the parameter for the mesh fitting. If 0, the convex-hull
| algorithm is used. It is suitable for convex bodies or if the
| intention is to enclose the `x`, `y` and `z` point set into a
| convex hull.
|
| The 'alphahull' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here `intensity`) or the bounds set
| in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as `intensity` and if set, `cmin` must be set as
| well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as `intensity`. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as `intensity` and if set, `cmax` must be set as
| well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| color
| Sets the color of the whole mesh
|
| The 'color' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
| - A number that will be interpreted as a color
| according to mesh3d.colorscale
|
| Returns
| -------
| str
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.mesh3d.
| colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.mesh3d.colorbar.tickformatstopdefaults), sets
| the default property values to use for elements
| of mesh3d.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.mesh3d.colorbar.Ti
| tle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| mesh3d.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| mesh3d.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contour
| The 'contour' property is an instance of Contour
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Contour`
| - A dict of string/value properties that will be passed
| to the Contour constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour lines.
| show
| Sets whether or not dynamic contours are shown
| on hover
| width
| Sets the width of the contour lines.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Contour
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| delaunayaxis
| Sets the Delaunay axis, which is the axis that is perpendicular
| to the surface of the Delaunay triangulation. It has an effect
| if `i`, `j`, `k` are not provided and `alphahull` is set to
| indicate Delaunay triangulation.
|
| The 'delaunayaxis' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['x', 'y', 'z']
|
| Returns
| -------
| Any
|
| facecolor
| Sets the color of each face Overrides "color" and
| "vertexcolor".
|
| The 'facecolor' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| facecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `facecolor`.
|
| The 'facecolorsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| flatshading
| Determines whether or not normal smoothing is applied to the
| meshes, creating meshes with an angular, low-poly look via flat
| reflections.
|
| The 'flatshading' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| i
| A vector of vertex indices, i.e. integer values between 0 and
| the length of the vertex vectors, representing the "first"
| vertex of a triangle. For example, `{i[m], j[m], k[m]}`
| together represent face m (triangle m) in the mesh, where `i[m]
| = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex
| arrays. Therefore, each element in `i` represents a point in
| space, which is the first vertex of a triangle.
|
| The 'i' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| intensity
| Sets the intensity values for vertices or cells as defined by
| `intensitymode`. It can be used for plotting fields on meshes.
|
| The 'intensity' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| intensitymode
| Determines the source of `intensity` values.
|
| The 'intensitymode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['vertex', 'cell']
|
| Returns
| -------
| Any
|
| intensitysrc
| Sets the source reference on Chart Studio Cloud for
| `intensity`.
|
| The 'intensitysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| isrc
| Sets the source reference on Chart Studio Cloud for `i`.
|
| The 'isrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| j
| A vector of vertex indices, i.e. integer values between 0 and
| the length of the vertex vectors, representing the "second"
| vertex of a triangle. For example, `{i[m], j[m], k[m]}`
| together represent face m (triangle m) in the mesh, where `j[m]
| = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex
| arrays. Therefore, each element in `j` represents a point in
| space, which is the second vertex of a triangle.
|
| The 'j' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| jsrc
| Sets the source reference on Chart Studio Cloud for `j`.
|
| The 'jsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| k
| A vector of vertex indices, i.e. integer values between 0 and
| the length of the vertex vectors, representing the "third"
| vertex of a triangle. For example, `{i[m], j[m], k[m]}`
| together represent face m (triangle m) in the mesh, where `k[m]
| = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex
| arrays. Therefore, each element in `k` represents a point in
| space, which is the third vertex of a triangle.
|
| The 'k' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ksrc
| Sets the source reference on Chart Studio Cloud for `k`.
|
| The 'ksrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.mesh3d.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.mesh3d.Stream
|
| text
| Sets the text elements associated with the vertices. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| vertexcolor
| Sets the color of each vertex Overrides "color". While Red,
| green and blue colors are in the range of 0 and 255; in the
| case of having vertex color data in RGBA format, the alpha
| color should be normalized to be between 0 and 1.
|
| The 'vertexcolor' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| vertexcolorsrc
| Sets the source reference on Chart Studio Cloud for
| `vertexcolor`.
|
| The 'vertexcolorsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the X coordinates of the vertices. The nth element of
| vectors `x`, `y` and `z` jointly represent the X, Y and Z
| coordinates of the nth vertex.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the Y coordinates of the vertices. The nth element of
| vectors `x`, `y` and `z` jointly represent the X, Y and Z
| coordinates of the nth vertex.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the Z coordinates of the vertices. The nth element of
| vectors `x`, `y` and `z` jointly represent the X, Y and Z
| coordinates of the nth vertex.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zcalendar
| Sets the calendar system to use with `z` date data.
|
| The 'zcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Ohlc(plotly.basedatatypes.BaseTraceType)
| Ohlc(arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
|
| Method resolution order:
| Ohlc
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, close=None, closesrc=None, customdata=None, customdatasrc=None, decreasing=None, high=None, highsrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, low=None, lowsrc=None, meta=None, metasrc=None, name=None, opacity=None, open=None, opensrc=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, tickwidth=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, yaxis=None, yhoverformat=None, zorder=None, **kwargs)
| Construct a new Ohlc object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Ohlc`
| close
| Sets the close values.
| closesrc
| Sets the source reference on Chart Studio Cloud for
| `close`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.ohlc.Decreasing` instance
| or dict with compatible properties
| high
| Sets the high values.
| highsrc
| Sets the source reference on Chart Studio Cloud for
| `high`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.ohlc.Hoverlabel` instance
| or dict with compatible properties
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.ohlc.Increasing` instance
| or dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.ohlc.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.ohlc.Line` instance or
| dict with compatible properties
| low
| Sets the low values.
| lowsrc
| Sets the source reference on Chart Studio Cloud for
| `low`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| open
| Sets the open values.
| opensrc
| Sets the source reference on Chart Studio Cloud for
| `open`.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.ohlc.Stream` instance or
| dict with compatible properties
| text
| Sets hover text elements associated with each sample
| point. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to this trace's sample points.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| tickwidth
| Sets the width of the open/close tick marks relative to
| the "x" minimal interval.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates. If absent, linear coordinate
| will be generated.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Ohlc
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| close
| Sets the close values.
|
| The 'close' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| closesrc
| Sets the source reference on Chart Studio Cloud for `close`.
|
| The 'closesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| decreasing
| The 'decreasing' property is an instance of Decreasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Decreasing`
| - A dict of string/value properties that will be passed
| to the Decreasing constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.ohlc.decreasing.Li
| ne` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.ohlc.Decreasing
|
| high
| Sets the high values.
|
| The 'high' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| highsrc
| Sets the source reference on Chart Studio Cloud for `high`.
|
| The 'highsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
| split
| Show hover information (open, close, high, low)
| in separate labels.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Hoverlabel
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| increasing
| The 'increasing' property is an instance of Increasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Increasing`
| - A dict of string/value properties that will be passed
| to the Increasing constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.ohlc.increasing.Li
| ne` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.ohlc.Increasing
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| Note that this style setting can also be set
| per direction via `increasing.line.dash` and
| `decreasing.line.dash`.
| width
| [object Object] Note that this style setting
| can also be set per direction via
| `increasing.line.width` and
| `decreasing.line.width`.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Line
|
| low
| Sets the low values.
|
| The 'low' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lowsrc
| Sets the source reference on Chart Studio Cloud for `low`.
|
| The 'lowsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| open
| Sets the open values.
|
| The 'open' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| opensrc
| Sets the source reference on Chart Studio Cloud for `open`.
|
| The 'opensrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.ohlc.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.ohlc.Stream
|
| text
| Sets hover text elements associated with each sample point. If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| this trace's sample points.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| tickwidth
| Sets the width of the open/close tick marks relative to the "x"
| minimal interval.
|
| The 'tickwidth' property is a number and may be specified as:
| - An int or float in the interval [0, 0.5]
|
| Returns
| -------
| int|float
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates. If absent, linear coordinate will be
| generated.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Parcats(plotly.basedatatypes.BaseTraceType)
| Parcats(arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)
|
| Method resolution order:
| Parcats
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, arrangement=None, bundlecolors=None, counts=None, countssrc=None, dimensions=None, dimensiondefaults=None, domain=None, hoverinfo=None, hoveron=None, hovertemplate=None, labelfont=None, legendgrouptitle=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, sortpaths=None, stream=None, tickfont=None, uid=None, uirevision=None, visible=None, **kwargs)
| Construct a new Parcats object
|
| Parallel categories diagram for multidimensional categorical
| data.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Parcats`
| arrangement
| Sets the drag interaction mode for categories and
| dimensions. If `perpendicular`, the categories can only
| move along a line perpendicular to the paths. If
| `freeform`, the categories can freely move on the
| plane. If `fixed`, the categories and dimensions are
| stationary.
| bundlecolors
| Sort paths so that like colors are bundled together
| within each category.
| counts
| The number of observations represented by each state.
| Defaults to 1 so that each state represents one
| observation
| countssrc
| Sets the source reference on Chart Studio Cloud for
| `counts`.
| dimensions
| The dimensions (variables) of the parallel categories
| diagram.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets
| the default property values to use for elements of
| parcats.dimensions
| domain
| :class:`plotly.graph_objects.parcats.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoveron
| Sets the hover interaction mode for the parcats
| diagram. If `category`, hover interaction take place
| per category. If `color`, hover interactions take place
| per color per category. If `dimension`, hover
| interactions take place across all categories per
| dimension.
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. This value here applies when hovering
| over dimensions. Note that `*categorycount`,
| "colorcount" and "bandcolorcount" are only available
| when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`,
| `probability`, `category`, `categorycount`,
| `colorcount` and `bandcolorcount`. Anything contained
| in tag `<extra>` is displayed in the secondary box, for
| example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| labelfont
| Sets the font for the `dimension` labels.
| legendgrouptitle
| :class:`plotly.graph_objects.parcats.Legendgrouptitle`
| instance or dict with compatible properties
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcats.Line` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort
| paths based on dimension categories from left to right.
| If `backward`, sort paths based on dimensions
| categories from right to left.
| stream
| :class:`plotly.graph_objects.parcats.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `category` labels.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Parcats
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| arrangement
| Sets the drag interaction mode for categories and dimensions.
| If `perpendicular`, the categories can only move along a line
| perpendicular to the paths. If `freeform`, the categories can
| freely move on the plane. If `fixed`, the categories and
| dimensions are stationary.
|
| The 'arrangement' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['perpendicular', 'freeform', 'fixed']
|
| Returns
| -------
| Any
|
| bundlecolors
| Sort paths so that like colors are bundled together within each
| category.
|
| The 'bundlecolors' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| counts
| The number of observations represented by each state. Defaults
| to 1 so that each state represents one observation
|
| The 'counts' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| countssrc
| Sets the source reference on Chart Studio Cloud for `counts`.
|
| The 'countssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcats.dimensiondefaults), sets the
| default property values to use for elements of
| parcats.dimensions
|
| The 'dimensiondefaults' property is an instance of Dimension
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Dimension`
| - A dict of string/value properties that will be passed
| to the Dimension constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.parcats.Dimension
|
| dimensions
| The dimensions (variables) of the parallel categories diagram.
|
| The 'dimensions' property is a tuple of instances of
| Dimension that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.parcats.Dimension
| - A list or tuple of dicts of string/value properties that
| will be passed to the Dimension constructor
|
| Supported dict properties:
|
| categoryarray
| Sets the order in which categories in this
| dimension appear. Only has an effect if
| `categoryorder` is set to "array". Used with
| `categoryorder`.
| categoryarraysrc
| Sets the source reference on Chart Studio Cloud
| for `categoryarray`.
| categoryorder
| Specifies the ordering logic for the categories
| in the dimension. By default, plotly uses
| "trace", which specifies the order that is
| present in the data supplied. Set
| `categoryorder` to *category ascending* or
| *category descending* if order should be
| determined by the alphanumerical order of the
| category names. Set `categoryorder` to "array"
| to derive the ordering from the attribute
| `categoryarray`. If a category is not found in
| the `categoryarray` array, the sorting behavior
| for that attribute will be identical to the
| "trace" mode. The unspecified categories will
| follow the categories in `categoryarray`.
| displayindex
| The display index of dimension, from left to
| right, zero indexed, defaults to dimension
| index.
| label
| The shown name of the dimension.
| ticktext
| Sets alternative tick labels for the categories
| in this dimension. Only has an effect if
| `categoryorder` is set to "array". Should be an
| array the same length as `categoryarray` Used
| with `categoryorder`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| values
| Dimension values. `values[n]` represents the
| category value of the `n`th point in the
| dataset, therefore the `values` vector for all
| dimensions must be the same (longer vectors
| will be truncated).
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
| visible
| Shows the dimension when set to `true` (the
| default). Hides the dimension for `false`.
|
| Returns
| -------
| tuple[plotly.graph_objs.parcats.Dimension]
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this parcats trace
| .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this parcats trace .
| x
| Sets the horizontal domain of this parcats
| trace (in plot fraction).
| y
| Sets the vertical domain of this parcats trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.parcats.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['count', 'probability'] joined with '+' characters
| (e.g. 'count+probability')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
| Returns
| -------
| Any
|
| hoveron
| Sets the hover interaction mode for the parcats diagram. If
| `category`, hover interaction take place per category. If
| `color`, hover interactions take place per color per category.
| If `dimension`, hover interactions take place across all
| categories per dimension.
|
| The 'hoveron' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['category', 'color', 'dimension']
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. This value
| here applies when hovering over dimensions. Note that
| `*categorycount`, "colorcount" and "bandcolorcount" are only
| available when `hoveron` contains the "color" flagFinally, the
| template string has access to variables `count`, `probability`,
| `category`, `categorycount`, `colorcount` and `bandcolorcount`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| labelfont
| Sets the font for the `dimension` labels.
|
| The 'labelfont' property is an instance of Labelfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Labelfont`
| - A dict of string/value properties that will be passed
| to the Labelfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcats.Labelfont
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.parcats.Legendgrouptitle
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `line.colorscale`. Has an effect
| only if in `line.color` is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `line.color`) or the bounds set in
| `line.cmin` and `line.cmax` Has an effect only
| if in `line.color` is set to a numerical array.
| Defaults to `false` when `line.cmin` and
| `line.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `line.cmin` and/or `line.cmax` to be
| equidistant to this point. Has an effect only
| if in `line.color` is set to a numerical array.
| Value should have the same units as in
| `line.color`. Has no effect when `line.cauto`
| is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmax` must be set as well.
| color
| Sets the line color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `line.cmin` and `line.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.parcats.line.Color
| Bar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `line.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `line.cmin` and `line.cmax`.
| Alternatively, `colorscale` may be a palette
| name string of the following list: Blackbody,Bl
| uered,Blues,Cividis,Earth,Electric,Greens,Greys
| ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
| dis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| hovertemplate
| Template string used for rendering the
| information that appear on hover box. Note that
| this will override `hoverinfo`. Variables are
| inserted using %{variable}, for example "y:
| %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for
| several points, "xother" will be added to those
| with different x positions from the first
| point. An underscore before or after
| "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price:
| %{y:$.2f}". https://github.com/d3/d3-
| format/tree/v1.4.5#d3-format for details on the
| formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-
| format}, for example "Day: %{2019-01-01|%A}".
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on
| the date formatting syntax. The variables
| available in `hovertemplate` are the ones
| emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-
| events/#event-data. Additionally, every
| attributes that can be specified per-point (the
| ones that are `arrayOk: true`) are available.
| This value here applies when hovering over
| lines.Finally, the template string has access
| to variables `count` and `probability`.
| Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `line.color` is set to a
| numerical array. If true, `line.cmin` will
| correspond to the last color in the array and
| `line.cmax` will correspond to the first color.
| shape
| Sets the shape of the paths. If `linear`, paths
| are composed of straight lines. If `hspline`,
| paths are composed of horizontal curved splines
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `line.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.parcats.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| sortpaths
| Sets the path sorting algorithm. If `forward`, sort paths based
| on dimension categories from left to right. If `backward`, sort
| paths based on dimensions categories from right to left.
|
| The 'sortpaths' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['forward', 'backward']
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.parcats.Stream
|
| tickfont
| Sets the font for the `category` labels.
|
| The 'tickfont' property is an instance of Tickfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcats.Tickfont`
| - A dict of string/value properties that will be passed
| to the Tickfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcats.Tickfont
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Parcoords(plotly.basedatatypes.BaseTraceType)
| Parcoords(arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Parcoords
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, customdata=None, customdatasrc=None, dimensions=None, dimensiondefaults=None, domain=None, ids=None, idssrc=None, labelangle=None, labelfont=None, labelside=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, rangefont=None, stream=None, tickfont=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Parcoords object
|
| Parallel coordinates for multidimensional exploratory data
| analysis. The samples are specified in `dimensions`. The colors
| are set in `line.color`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Parcoords`
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dimensions
| The dimensions (variables) of the parallel coordinates
| chart. 2..60 dimensions are supported.
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets
| the default property values to use for elements of
| parcoords.dimensions
| domain
| :class:`plotly.graph_objects.parcoords.Domain` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| labelangle
| Sets the angle of the labels with respect to the
| horizontal. For example, a `tickangle` of -90 draws the
| labels vertically. Tilted labels with "labelangle" may
| be positioned better inside margins when
| `labelposition` is set to "bottom".
| labelfont
| Sets the font for the `dimension` labels.
| labelside
| Specifies the location of the `label`. "top" positions
| labels above, next to the title "bottom" positions
| labels below the graph Tilted labels with "labelangle"
| may be positioned better inside margins when
| `labelposition` is set to "bottom".
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.parcoords.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.parcoords.Line` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| rangefont
| Sets the font for the `dimension` range values.
| stream
| :class:`plotly.graph_objects.parcoords.Stream` instance
| or dict with compatible properties
| tickfont
| Sets the font for the `dimension` tick values.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.parcoords.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Parcoords
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dimensiondefaults
| When used in a template (as
| layout.template.data.parcoords.dimensiondefaults), sets the
| default property values to use for elements of
| parcoords.dimensions
|
| The 'dimensiondefaults' property is an instance of Dimension
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Dimension`
| - A dict of string/value properties that will be passed
| to the Dimension constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.parcoords.Dimension
|
| dimensions
| The dimensions (variables) of the parallel coordinates chart.
| 2..60 dimensions are supported.
|
| The 'dimensions' property is a tuple of instances of
| Dimension that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.parcoords.Dimension
| - A list or tuple of dicts of string/value properties that
| will be passed to the Dimension constructor
|
| Supported dict properties:
|
| constraintrange
| The domain range to which the filter on the
| dimension is constrained. Must be an array of
| `[fromValue, toValue]` with `fromValue <=
| toValue`, or if `multiselect` is not disabled,
| you may give an array of arrays, where each
| inner array is `[fromValue, toValue]`.
| label
| The shown name of the dimension.
| multiselect
| Do we allow multiple selection ranges or just a
| single range?
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| range
| The domain range that represents the full,
| shown axis extent. Defaults to the `values`
| extent. Must be an array of `[fromValue,
| toValue]` with finite numbers as elements.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| values
| Dimension values. `values[n]` represents the
| value of the `n`th point in the dataset,
| therefore the `values` vector for all
| dimensions must be the same (longer vectors
| will be truncated). Each value must be a finite
| number.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
| visible
| Shows the dimension when set to `true` (the
| default). Hides the dimension for `false`.
|
| Returns
| -------
| tuple[plotly.graph_objs.parcoords.Dimension]
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this parcoords
| trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this parcoords trace .
| x
| Sets the horizontal domain of this parcoords
| trace (in plot fraction).
| y
| Sets the vertical domain of this parcoords
| trace (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.parcoords.Domain
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| labelangle
| Sets the angle of the labels with respect to the horizontal.
| For example, a `tickangle` of -90 draws the labels vertically.
| Tilted labels with "labelangle" may be positioned better inside
| margins when `labelposition` is set to "bottom".
|
| The 'labelangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| labelfont
| Sets the font for the `dimension` labels.
|
| The 'labelfont' property is an instance of Labelfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Labelfont`
| - A dict of string/value properties that will be passed
| to the Labelfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Labelfont
|
| labelside
| Specifies the location of the `label`. "top" positions labels
| above, next to the title "bottom" positions labels below the
| graph Tilted labels with "labelangle" may be positioned better
| inside margins when `labelposition` is set to "bottom".
|
| The 'labelside' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top', 'bottom']
|
| Returns
| -------
| Any
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `line.colorscale`. Has an effect
| only if in `line.color` is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `line.color`) or the bounds set in
| `line.cmin` and `line.cmax` Has an effect only
| if in `line.color` is set to a numerical array.
| Defaults to `false` when `line.cmin` and
| `line.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `line.cmin` and/or `line.cmax` to be
| equidistant to this point. Has an effect only
| if in `line.color` is set to a numerical array.
| Value should have the same units as in
| `line.color`. Has no effect when `line.cauto`
| is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmax` must be set as well.
| color
| Sets the line color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `line.cmin` and `line.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.parcoords.line.Col
| orBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `line.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `line.cmin` and `line.cmax`.
| Alternatively, `colorscale` may be a palette
| name string of the following list: Blackbody,Bl
| uered,Blues,Cividis,Earth,Electric,Greens,Greys
| ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
| dis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `line.color` is set to a
| numerical array. If true, `line.cmin` will
| correspond to the last color in the array and
| `line.cmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `line.color` is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Line
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| rangefont
| Sets the font for the `dimension` range values.
|
| The 'rangefont' property is an instance of Rangefont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Rangefont`
| - A dict of string/value properties that will be passed
| to the Rangefont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Rangefont
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Stream
|
| tickfont
| Sets the font for the `dimension` tick values.
|
| The 'tickfont' property is an instance of Tickfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Tickfont`
| - A dict of string/value properties that will be passed
| to the Tickfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.parcoords.Tickfont
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.parcoords.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.parcoords.unselect
| ed.Line` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.parcoords.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Pie(plotly.basedatatypes.BaseTraceType)
| Pie(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Pie
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, title=None, titlefont=None, titleposition=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Pie object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Pie`
| automargin
| Determines whether outside text labels can push the
| margins.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| direction
| Specifies the direction at which succeeding sectors
| follow one another.
| dlabel
| Sets the label step. See `label0` for more info.
| domain
| :class:`plotly.graph_objects.pie.Domain` instance or
| dict with compatible properties
| hole
| Sets the fraction of the radius to cut out of the pie.
| Use this to make a donut chart.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pie.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| label0
| Alternate to `labels`. Builds a numeric set of labels.
| Use with `dlabel` where `label0` is the starting label
| and `dlabel` the step.
| labels
| Sets the sector labels. If `labels` entries are
| duplicated, we sum associated `values` or simply count
| occurrences if `values` is not provided. For other
| array attributes (including color) we use the first
| non-empty entry among all occurrences of the label.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pie.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pie.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector.
| pull
| Sets the fraction of larger radius to pull the sectors
| out from the center. This can be a constant to pull all
| slices apart from each other equally or an array to
| highlight one or more slices.
| pullsrc
| Sets the source reference on Chart Studio Cloud for
| `pull`.
| rotation
| Instead of the first slice starting at 12 o'clock,
| rotate to some other angle.
| scalegroup
| If there are multiple pie charts that should be sized
| according to their totals, link them by providing a
| non-empty group id here shared by every trace in the
| same group.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.pie.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Specifies the location of the `textinfo`.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `label`, `color`, `value`, `percent` and
| `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| title
| :class:`plotly.graph_objects.pie.Title` instance or
| dict with compatible properties
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the
| font used for `title`. Note that the title's font used
| to be set by the now deprecated `titlefont` attribute.
| titleposition
| Deprecated: Please use pie.title.position instead.
| Specifies the location of the `title`. Note that the
| title's position used to be set by the now deprecated
| `titleposition` attribute.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Pie
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| automargin
| Determines whether outside text labels can push the margins.
|
| The 'automargin' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| direction
| Specifies the direction at which succeeding sectors follow one
| another.
|
| The 'direction' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['clockwise', 'counterclockwise']
|
| Returns
| -------
| Any
|
| dlabel
| Sets the label step. See `label0` for more info.
|
| The 'dlabel' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this pie trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this pie trace .
| x
| Sets the horizontal domain of this pie trace
| (in plot fraction).
| y
| Sets the vertical domain of this pie trace (in
| plot fraction).
|
| Returns
| -------
| plotly.graph_objs.pie.Domain
|
| hole
| Sets the fraction of the radius to cut out of the pie. Use this
| to make a donut chart.
|
| The 'hole' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.pie.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `label`, `color`,
| `value`, `percent` and `text`. Anything contained in tag
| `<extra>` is displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.pie.Insidetextfont
|
| insidetextorientation
| Controls the orientation of the text inside chart sectors. When
| set to "auto", text may be oriented in any direction in order
| to be as big as possible in the middle of a sector. The
| "horizontal" option orients text to be parallel with the bottom
| of the chart, and may make text smaller in order to achieve
| that goal. The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text perpendicular
| to the radius of the sector.
|
| The 'insidetextorientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['horizontal', 'radial', 'tangential', 'auto']
|
| Returns
| -------
| Any
|
| label0
| Alternate to `labels`. Builds a numeric set of labels. Use with
| `dlabel` where `label0` is the starting label and `dlabel` the
| step.
|
| The 'label0' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| labels
| Sets the sector labels. If `labels` entries are duplicated, we
| sum associated `values` or simply count occurrences if `values`
| is not provided. For other array attributes (including color)
| we use the first non-empty entry among all occurrences of the
| label.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.pie.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| colors
| Sets the color of each sector. If not
| specified, the default trace color set is used
| to pick the sector colors.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.pie.marker.Line`
| instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
|
| Returns
| -------
| plotly.graph_objs.pie.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.pie.Outsidetextfont
|
| pull
| Sets the fraction of larger radius to pull the sectors out from
| the center. This can be a constant to pull all slices apart
| from each other equally or an array to highlight one or more
| slices.
|
| The 'pull' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| pullsrc
| Sets the source reference on Chart Studio Cloud for `pull`.
|
| The 'pullsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| rotation
| Instead of the first slice starting at 12 o'clock, rotate to
| some other angle.
|
| The 'rotation' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| scalegroup
| If there are multiple pie charts that should be sized according
| to their totals, link them by providing a non-empty group id
| here shared by every trace in the same group.
|
| The 'scalegroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.pie.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.pie.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `textinfo`.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `label`,
| `color`, `value`, `percent` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| title
| The 'title' property is an instance of Title
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.Title`
| - A dict of string/value properties that will be passed
| to the Title constructor
|
| Supported dict properties:
|
| font
| Sets the font used for `title`. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| position
| Specifies the location of the `title`. Note
| that the title's position used to be set by the
| now deprecated `titleposition` attribute.
| text
| Sets the title of the chart. If it is empty, no
| title is displayed. Note that before the
| existence of `title.text`, the title's contents
| used to be defined as the `title` attribute
| itself. This behavior has been deprecated.
|
| Returns
| -------
| plotly.graph_objs.pie.Title
|
| titlefont
| Deprecated: Please use pie.title.font instead. Sets the font
| used for `title`. Note that the title's font used to be set by
| the now deprecated `titlefont` attribute.
|
| The 'font' property is an instance of Font
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pie.title.Font`
| - A dict of string/value properties that will be passed
| to the Font constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
|
| titleposition
| Deprecated: Please use pie.title.position instead. Specifies
| the location of the `title`. Note that the title's position
| used to be set by the now deprecated `titleposition` attribute.
|
| The 'position' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle center',
| 'bottom left', 'bottom center', 'bottom right']
|
| Returns
| -------
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values of the sectors. If omitted, we count
| occurrences of each label.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Pointcloud(plotly.basedatatypes.BaseTraceType)
| Pointcloud(arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, **kwargs)
|
| Method resolution order:
| Pointcloud
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, indices=None, indicessrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xaxis=None, xbounds=None, xboundssrc=None, xsrc=None, xy=None, xysrc=None, y=None, yaxis=None, ybounds=None, yboundssrc=None, ysrc=None, **kwargs)
| Construct a new Pointcloud object
|
| "pointcloud" trace is deprecated! Please consider switching to
| the "scattergl" trace type. The data visualized as a point
| cloud set in `x` and `y` using the WebGl plotting engine.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Pointcloud`
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.pointcloud.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| indices
| A sequential value, 0..n, supply it to avoid creating
| this array inside plotting. If specified, it must be a
| typed `Int32Array` array. Its length must be equal to
| or greater than the number of points. For the best
| performance and memory use, create one large `indices`
| typed array that is guaranteed to be at least as long
| as the largest number of points during use, and reuse
| it on each `Plotly.restyle()` call.
| indicessrc
| Sets the source reference on Chart Studio Cloud for
| `indices`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.pointcloud.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.pointcloud.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.pointcloud.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `ybounds` for the performance
| benefits.
| xboundssrc
| Sets the source reference on Chart Studio Cloud for
| `xbounds`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| xy
| Faster alternative to specifying `x` and `y`
| separately. If supplied, it must be a typed
| `Float32Array` array that represents points such that
| `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`
| xysrc
| Sets the source reference on Chart Studio Cloud for
| `xy`.
| y
| Sets the y coordinates.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to
| avoid looping through the `xy` typed array. Use it in
| conjunction with `xy` and `xbounds` for the performance
| benefits.
| yboundssrc
| Sets the source reference on Chart Studio Cloud for
| `ybounds`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
|
| Returns
| -------
| Pointcloud
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| indices
| A sequential value, 0..n, supply it to avoid creating this
| array inside plotting. If specified, it must be a typed
| `Int32Array` array. Its length must be equal to or greater than
| the number of points. For the best performance and memory use,
| create one large `indices` typed array that is guaranteed to be
| at least as long as the largest number of points during use,
| and reuse it on each `Plotly.restyle()` call.
|
| The 'indices' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| indicessrc
| Sets the source reference on Chart Studio Cloud for `indices`.
|
| The 'indicessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| blend
| Determines if colors are blended together for a
| translucency effect in case `opacity` is
| specified as a value less then `1`. Setting
| `blend` to `true` reduces zoom/pan speed if
| used with large numbers of points.
| border
| :class:`plotly.graph_objects.pointcloud.marker.
| Border` instance or dict with compatible
| properties
| color
| Sets the marker fill color. It accepts a
| specific color. If the color is not fully
| opaque and there are hundreds of thousands of
| points, it may cause slower zooming and
| panning.
| opacity
| Sets the marker opacity. The default value is
| `1` (fully opaque). If the markers are not
| fully opaque and there are hundreds of
| thousands of points, it may cause slower
| zooming and panning. Opacity fades the color
| even if `blend` is left on `false` even if
| there is no translucency effect in that case.
| sizemax
| Sets the maximum size (in px) of the rendered
| marker points. Effective when the `pointcloud`
| shows only few points.
| sizemin
| Sets the minimum size (in px) of the rendered
| marker points, effective when the `pointcloud`
| shows a million or more points.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.pointcloud.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.pointcloud.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xbounds
| Specify `xbounds` in the shape of `[xMin, xMax] to avoid
| looping through the `xy` typed array. Use it in conjunction
| with `xy` and `ybounds` for the performance benefits.
|
| The 'xbounds' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xboundssrc
| Sets the source reference on Chart Studio Cloud for `xbounds`.
|
| The 'xboundssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| xy
| Faster alternative to specifying `x` and `y` separately. If
| supplied, it must be a typed `Float32Array` array that
| represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 +
| 1] = y[i]`
|
| The 'xy' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xysrc
| Sets the source reference on Chart Studio Cloud for `xy`.
|
| The 'xysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ybounds
| Specify `ybounds` in the shape of `[yMin, yMax] to avoid
| looping through the `xy` typed array. Use it in conjunction
| with `xy` and `xbounds` for the performance benefits.
|
| The 'ybounds' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yboundssrc
| Sets the source reference on Chart Studio Cloud for `ybounds`.
|
| The 'yboundssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class RadialAxis(builtins.dict)
| RadialAxis(*args, **kwargs)
|
| plotly.graph_objs.RadialAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.RadialAxis
| - plotly.graph_objs.layout.polar.RadialAxis
|
| Method resolution order:
| RadialAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.RadialAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.RadialAxis
| - plotly.graph_objs.layout.polar.RadialAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Sankey(plotly.basedatatypes.BaseTraceType)
| Sankey(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)
|
| Method resolution order:
| Sankey
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)
| Construct a new Sankey object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Sankey`
| arrangement
| If value is `snap` (the default), the node arrangement
| is assisted by automatic snapping of elements to
| preserve space between nodes specified via `nodepad`.
| If value is `perpendicular`, the nodes can only move
| along a line perpendicular to the flow. If value is
| `freeform`, the nodes can freely move on the plane. If
| value is `fixed`, the nodes are stationary.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sankey.Domain` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired. Note that this attribute is
| superseded by `node.hoverinfo` and `node.hoverinfo` for
| nodes and links respectively.
| hoverlabel
| :class:`plotly.graph_objects.sankey.Hoverlabel`
| instance or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sankey.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| link
| The links of the Sankey plot.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| node
| The nodes of the Sankey plot.
| orientation
| Sets the orientation of the Sankey diagram.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| stream
| :class:`plotly.graph_objects.sankey.Stream` instance or
| dict with compatible properties
| textfont
| Sets the font for node labels
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| valueformat
| Sets the value formatting rule using d3 formatting
| mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| valuesuffix
| Adds a unit to follow the value in the hover tooltip.
| Add a space if a separation is necessary from the
| value.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Sankey
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| arrangement
| If value is `snap` (the default), the node arrangement is
| assisted by automatic snapping of elements to preserve space
| between nodes specified via `nodepad`. If value is
| `perpendicular`, the nodes can only move along a line
| perpendicular to the flow. If value is `freeform`, the nodes
| can freely move on the plane. If value is `fixed`, the nodes
| are stationary.
|
| The 'arrangement' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['snap', 'perpendicular', 'freeform', 'fixed']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this sankey trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this sankey trace .
| x
| Sets the horizontal domain of this sankey trace
| (in plot fraction).
| y
| Sets the vertical domain of this sankey trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.sankey.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
| Note that this attribute is superseded by `node.hoverinfo` and
| `node.hoverinfo` for nodes and links respectively.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of [] joined with '+' characters
| (e.g. '')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
| Returns
| -------
| Any
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.sankey.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.sankey.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| link
| The links of the Sankey plot.
|
| The 'link' property is an instance of Link
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Link`
| - A dict of string/value properties that will be passed
| to the Link constructor
|
| Supported dict properties:
|
| arrowlen
| Sets the length (in px) of the links arrow, if
| 0 no arrow will be drawn.
| color
| Sets the `link` color. It can be a single
| value, or an array for specifying color for
| each `link`. If `link.color` is omitted, then
| by default, a translucent grey link will be
| used.
| colorscales
| A tuple of :class:`plotly.graph_objects.sankey.
| link.Colorscale` instances or dicts with
| compatible properties
| colorscaledefaults
| When used in a template (as layout.template.dat
| a.sankey.link.colorscaledefaults), sets the
| default property values to use for elements of
| sankey.link.colorscales
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| customdata
| Assigns extra data to each link.
| customdatasrc
| Sets the source reference on Chart Studio Cloud
| for `customdata`.
| hovercolor
| Sets the `link` hover color. It can be a single
| value, or an array for specifying hover colors
| for each `link`. If `link.hovercolor` is
| omitted, then by default, links will become
| slightly more opaque when hovered over.
| hovercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `hovercolor`.
| hoverinfo
| Determines which trace information appear when
| hovering links. If `none` or `skip` are set, no
| information is displayed upon hovering. But, if
| `none` is set, click and hover events are still
| fired.
| hoverlabel
| :class:`plotly.graph_objects.sankey.link.Hoverl
| abel` instance or dict with compatible
| properties
| hovertemplate
| Template string used for rendering the
| information that appear on hover box. Note that
| this will override `hoverinfo`. Variables are
| inserted using %{variable}, for example "y:
| %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for
| several points, "xother" will be added to those
| with different x positions from the first
| point. An underscore before or after
| "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price:
| %{y:$.2f}". https://github.com/d3/d3-
| format/tree/v1.4.5#d3-format for details on the
| formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-
| format}, for example "Day: %{2019-01-01|%A}".
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on
| the date formatting syntax. The variables
| available in `hovertemplate` are the ones
| emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-
| events/#event-data. Additionally, every
| attributes that can be specified per-point (the
| ones that are `arrayOk: true`) are available.
| Variables `source` and `target` are node
| objects.Finally, the template string has access
| to variables `value` and `label`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud
| for `hovertemplate`.
| label
| The shown name of the link.
| labelsrc
| Sets the source reference on Chart Studio Cloud
| for `label`.
| line
| :class:`plotly.graph_objects.sankey.link.Line`
| instance or dict with compatible properties
| source
| An integer number `[0..nodes.length - 1]` that
| represents the source node.
| sourcesrc
| Sets the source reference on Chart Studio Cloud
| for `source`.
| target
| An integer number `[0..nodes.length - 1]` that
| represents the target node.
| targetsrc
| Sets the source reference on Chart Studio Cloud
| for `target`.
| value
| A numeric value representing the flow volume
| value.
| valuesrc
| Sets the source reference on Chart Studio Cloud
| for `value`.
|
| Returns
| -------
| plotly.graph_objs.sankey.Link
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| node
| The nodes of the Sankey plot.
|
| The 'node' property is an instance of Node
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Node`
| - A dict of string/value properties that will be passed
| to the Node constructor
|
| Supported dict properties:
|
| align
| Sets the alignment method used to position the
| nodes along the horizontal axis.
| color
| Sets the `node` color. It can be a single
| value, or an array for specifying color for
| each `node`. If `node.color` is omitted, then
| the default `Plotly` color palette will be
| cycled through to have a variety of colors.
| These defaults are not fully opaque, to allow
| some visibility of what is beneath the node.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| customdata
| Assigns extra data to each node.
| customdatasrc
| Sets the source reference on Chart Studio Cloud
| for `customdata`.
| groups
| Groups of nodes. Each group is defined by an
| array with the indices of the nodes it
| contains. Multiple groups can be specified.
| hoverinfo
| Determines which trace information appear when
| hovering nodes. If `none` or `skip` are set, no
| information is displayed upon hovering. But, if
| `none` is set, click and hover events are still
| fired.
| hoverlabel
| :class:`plotly.graph_objects.sankey.node.Hoverl
| abel` instance or dict with compatible
| properties
| hovertemplate
| Template string used for rendering the
| information that appear on hover box. Note that
| this will override `hoverinfo`. Variables are
| inserted using %{variable}, for example "y:
| %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for
| several points, "xother" will be added to those
| with different x positions from the first
| point. An underscore before or after
| "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are
| formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price:
| %{y:$.2f}". https://github.com/d3/d3-
| format/tree/v1.4.5#d3-format for details on the
| formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-
| format}, for example "Day: %{2019-01-01|%A}".
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on
| the date formatting syntax. The variables
| available in `hovertemplate` are the ones
| emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-
| events/#event-data. Additionally, every
| attributes that can be specified per-point (the
| ones that are `arrayOk: true`) are available.
| Variables `sourceLinks` and `targetLinks` are
| arrays of link objects.Finally, the template
| string has access to variables `value` and
| `label`. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag
| `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud
| for `hovertemplate`.
| label
| The shown name of the node.
| labelsrc
| Sets the source reference on Chart Studio Cloud
| for `label`.
| line
| :class:`plotly.graph_objects.sankey.node.Line`
| instance or dict with compatible properties
| pad
| Sets the padding (in px) between the `nodes`.
| thickness
| Sets the thickness (in px) of the `nodes`.
| x
| The normalized horizontal position of the node.
| xsrc
| Sets the source reference on Chart Studio Cloud
| for `x`.
| y
| The normalized vertical position of the node.
| ysrc
| Sets the source reference on Chart Studio Cloud
| for `y`.
|
| Returns
| -------
| plotly.graph_objs.sankey.Node
|
| orientation
| Sets the orientation of the Sankey diagram.
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.sankey.Stream
|
| textfont
| Sets the font for node labels
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sankey.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| variant
| Sets the variant of the font.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.sankey.Textfont
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| valueformat
| Sets the value formatting rule using d3 formatting mini-
| languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
| The 'valueformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| valuesuffix
| Adds a unit to follow the value in the hover tooltip. Add a
| space if a separation is necessary from the value.
|
| The 'valuesuffix' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatter(plotly.basedatatypes.BaseTraceType)
| Scatter(arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Scatter
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, fillgradient=None, fillpattern=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Scatter object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scatter`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scatter.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available. If fillgradient is
| specified, fillcolor is ignored except for setting the
| background color of the hover label, if any.
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor
| is used instead.
| fillpattern
| Sets the pattern within the marker.
| groupnorm
| Only relevant when `stackgroup` is used, and only the
| first `groupnorm` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Sets the normalization for the sum of
| this `stackgroup`. With "fraction", the value of each
| trace at each location is divided by the sum of all
| trace values at that location. "percent" is the same
| but multiplied by 100 to show percentages. If there are
| multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Only relevant in the following cases: 1. when
| `scattermode` is set to "group". 2. when `stackgroup`
| is used, and only the first `orientation` found in the
| `stackgroup` will be used - including if `visible` is
| "legendonly" but not if it is `false`. Sets the
| stacking direction. With "v" ("h"), the y (x) values of
| subsequent traces are added. Also affects the default
| value of `fill`.
| selected
| :class:`plotly.graph_objects.scatter.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stackgaps
| Only relevant when `stackgroup` is used, and only the
| first `stackgaps` found in the `stackgroup` will be
| used - including if `visible` is "legendonly" but not
| if it is `false`. Determines how we handle locations at
| which other traces in this group have data but this one
| does not. With *infer zero* we insert a zero at these
| locations. With "interpolate" we linearly interpolate
| between existing values, and extrapolate a constant
| beyond the existing values.
| stackgroup
| Set several scatter traces (on the same subplot) to the
| same stackgroup in order to add their y values (or
| their x values if `orientation` is "h"). If blank or
| omitted this trace will not be stacked. Stacking also
| turns `fill` on by default, using "tonexty" ("tonextx")
| if `orientation` is "h" ("v") and sets the default
| `mode` to "lines" irrespective of point count. You can
| only stack on a numeric (linear or log) axis. Traces in
| a `stackgroup` will only fill to (or be filled to)
| other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if
| fill-linked traces are not already consecutive, the
| later ones will be pushed down in the drawing order.
| stream
| :class:`plotly.graph_objects.scatter.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatter.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Scatter
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter.ErrorY
|
| fill
| Sets the area to fill with a solid color. Defaults to "none"
| unless this trace is stacked, then it gets "tonexty"
| ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor`
| if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0
| respectively. "tonextx" and "tonexty" fill between the
| endpoints of this trace and the endpoints of the trace before
| it, connecting those endpoints with straight lines (to make a
| stacked area graph); if there is no trace before it, they
| behave like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if it has
| gaps) into a closed shape. "tonext" fills the space between two
| traces if one completely encloses the other (eg consecutive
| contour lines), and behaves like "toself" if there is no trace
| before it. "tonext" should not be used if one trace does not
| enclose the other. Traces in a `stackgroup` will only fill to
| (or be filled to) other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if fill-
| linked traces are not already consecutive, the later ones will
| be pushed down in the drawing order.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx',
| 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available. If fillgradient is specified, fillcolor is
| ignored except for setting the background color of the hover
| label, if any.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| fillgradient
| Sets a fill gradient. If not specified, the fillcolor is used
| instead.
|
| The 'fillgradient' property is an instance of Fillgradient
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Fillgradient`
| - A dict of string/value properties that will be passed
| to the Fillgradient constructor
|
| Supported dict properties:
|
| colorscale
| Sets the fill gradient colors as a color scale.
| The color scale is interpreted as a gradient
| applied in the direction specified by
| "orientation", from the lowest to the highest
| value of the scatter plot along that axis, or
| from the center to the most distant point from
| it, if orientation is "radial".
| start
| Sets the gradient start value. It is given as
| the absolute position on the axis determined by
| the orientiation. E.g., if orientation is
| "horizontal", the gradient will be horizontal
| and start from the x-position given by start.
| If omitted, the gradient starts at the lowest
| value of the trace along the respective axis.
| Ignored if orientation is "radial".
| stop
| Sets the gradient end value. It is given as the
| absolute position on the axis determined by the
| orientiation. E.g., if orientation is
| "horizontal", the gradient will be horizontal
| and end at the x-position given by end. If
| omitted, the gradient ends at the highest value
| of the trace along the respective axis. Ignored
| if orientation is "radial".
| type
| Sets the type/orientation of the color gradient
| for the fill. Defaults to "none".
|
| Returns
| -------
| plotly.graph_objs.scatter.Fillgradient
|
| fillpattern
| Sets the pattern within the marker.
|
| The 'fillpattern' property is an instance of Fillpattern
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Fillpattern`
| - A dict of string/value properties that will be passed
| to the Fillpattern constructor
|
| Supported dict properties:
|
| bgcolor
| When there is no colorscale sets the color of
| background pattern fill. Defaults to a
| `marker.color` background when `fillmode` is
| "overlay". Otherwise, defaults to a transparent
| background.
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| fgcolor
| When there is no colorscale sets the color of
| foreground pattern fill. Defaults to a
| `marker.color` background when `fillmode` is
| "replace". Otherwise, defaults to dark grey or
| white to increase contrast with the `bgcolor`.
| fgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `fgcolor`.
| fgopacity
| Sets the opacity of the foreground pattern
| fill. Defaults to a 0.5 when `fillmode` is
| "overlay". Otherwise, defaults to 1.
| fillmode
| Determines whether `marker.color` should be
| used as a default to `bgcolor` or a `fgcolor`.
| shape
| Sets the shape of the pattern fill. By default,
| no pattern is used for filling the area.
| shapesrc
| Sets the source reference on Chart Studio Cloud
| for `shape`.
| size
| Sets the size of unit squares of the pattern
| fill in pixels, which corresponds to the
| interval of repetition of the pattern.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| solidity
| Sets the solidity of the pattern fill. Solidity
| is roughly the fraction of the area filled by
| the pattern. Solidity of 0 shows only the
| background color without pattern and solidty of
| 1 shows only the foreground color without
| pattern.
| soliditysrc
| Sets the source reference on Chart Studio Cloud
| for `solidity`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Fillpattern
|
| groupnorm
| Only relevant when `stackgroup` is used, and only the first
| `groupnorm` found in the `stackgroup` will be used - including
| if `visible` is "legendonly" but not if it is `false`. Sets the
| normalization for the sum of this `stackgroup`. With
| "fraction", the value of each trace at each location is divided
| by the sum of all trace values at that location. "percent" is
| the same but multiplied by 100 to show percentages. If there
| are multiple subplots, or multiple `stackgroup`s on one
| subplot, each will be normalized within its own set.
|
| The 'groupnorm' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['', 'fraction', 'percent']
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatter.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| simplify
| Simplifies lines by removing nearly-collinear
| points. When transitioning lines, it may be
| desirable to disable this so that the number of
| points along the resulting SVG path is
| unaffected.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatter.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatter.marker.Col
| orBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scatter.marker.Gra
| dient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scatter.marker.Lin
| e` instance or dict with compatible properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Only relevant in the following cases: 1. when `scattermode` is
| set to "group". 2. when `stackgroup` is used, and only the
| first `orientation` found in the `stackgroup` will be used -
| including if `visible` is "legendonly" but not if it is
| `false`. Sets the stacking direction. With "v" ("h"), the y (x)
| values of subsequent traces are added. Also affects the default
| value of `fill`.
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatter.selected.M
| arker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatter.selected.T
| extfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatter.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stackgaps
| Only relevant when `stackgroup` is used, and only the first
| `stackgaps` found in the `stackgroup` will be used - including
| if `visible` is "legendonly" but not if it is `false`.
| Determines how we handle locations at which other traces in
| this group have data but this one does not. With *infer zero*
| we insert a zero at these locations. With "interpolate" we
| linearly interpolate between existing values, and extrapolate a
| constant beyond the existing values.
|
| The 'stackgaps' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['infer zero', 'interpolate']
|
| Returns
| -------
| Any
|
| stackgroup
| Set several scatter traces (on the same subplot) to the same
| stackgroup in order to add their y values (or their x values if
| `orientation` is "h"). If blank or omitted this trace will not
| be stacked. Stacking also turns `fill` on by default, using
| "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets
| the default `mode` to "lines" irrespective of point count. You
| can only stack on a numeric (linear or log) axis. Traces in a
| `stackgroup` will only fill to (or be filled to) other traces
| in the same group. With multiple `stackgroup`s or some traces
| stacked and some not, if fill-linked traces are not already
| consecutive, the later ones will be pushed down in the drawing
| order.
|
| The 'stackgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatter.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatter.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatter.unselected
| .Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatter.unselected
| .Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatter.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatter3d(plotly.basedatatypes.BaseTraceType)
| Scatter3d(arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Scatter3d
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, error_z=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, projection=None, scene=None, showlegend=None, stream=None, surfaceaxis=None, surfacecolor=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Scatter3d object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scatter3d`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| error_x
| :class:`plotly.graph_objects.scatter3d.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scatter3d.ErrorY` instance
| or dict with compatible properties
| error_z
| :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatter3d.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatter3d.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatter3d.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| projection
| :class:`plotly.graph_objects.scatter3d.Projection`
| instance or dict with compatible properties
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatter3d.Stream` instance
| or dict with compatible properties
| surfaceaxis
| If "-1", the scatter points are not fill with a surface
| If 0, 1, 2, the scatter points are filled with a
| Delaunay surface about the x, y, z respectively.
| surfacecolor
| Sets the surface fill color.
| text
| Sets text elements associated with each (x,y,z)
| triplet. If a single string, the same string appears
| over all the data points. If an array of string, the
| items are mapped in order to the this trace's (x,y,z)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Scatter3d
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_zstyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_zstyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.ErrorY
|
| error_z
| The 'error_z' property is an instance of ErrorZ
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.ErrorZ`
| - A dict of string/value properties that will be passed
| to the ErrorZ constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.ErrorZ
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets text elements associated with each (x,y,z) triplet. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y,z) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `line.colorscale`. Has an effect
| only if in `line.color` is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `line.color`) or the bounds set in
| `line.cmin` and `line.cmax` Has an effect only
| if in `line.color` is set to a numerical array.
| Defaults to `false` when `line.cmin` and
| `line.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `line.cmin` and/or `line.cmax` to be
| equidistant to this point. Has an effect only
| if in `line.color` is set to a numerical array.
| Value should have the same units as in
| `line.color`. Has no effect when `line.cauto`
| is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `line.color` is set to a
| numerical array. Value should have the same
| units as in `line.color` and if set,
| `line.cmax` must be set as well.
| color
| Sets the line color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `line.cmin` and `line.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatter3d.line.Col
| orBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `line.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `line.cmin` and `line.cmax`.
| Alternatively, `colorscale` may be a palette
| name string of the following list: Blackbody,Bl
| uered,Blues,Cividis,Earth,Electric,Greens,Greys
| ,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
| dis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| dash
| Sets the dash style of the lines.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `line.color` is set to a
| numerical array. If true, `line.cmin` will
| correspond to the last color in the array and
| `line.cmax` will correspond to the first color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `line.color` is set to a numerical array.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatter3d.marker.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.scatter3d.marker.L
| ine` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity. Note that the marker
| opacity for scatter3d traces must be a scalar
| value for performance reasons. To set a
| blending opacity value (i.e. which is not
| transparent), set "marker.color" to an rgba
| color and use its alpha channel.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| projection
| The 'projection' property is an instance of Projection
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Projection`
| - A dict of string/value properties that will be passed
| to the Projection constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.scatter3d.projecti
| on.X` instance or dict with compatible
| properties
| y
| :class:`plotly.graph_objects.scatter3d.projecti
| on.Y` instance or dict with compatible
| properties
| z
| :class:`plotly.graph_objects.scatter3d.projecti
| on.Z` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Projection
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Stream
|
| surfaceaxis
| If "-1", the scatter points are not fill with a surface If 0,
| 1, 2, the scatter points are filled with a Delaunay surface
| about the x, y, z respectively.
|
| The 'surfaceaxis' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [-1, 0, 1, 2]
|
| Returns
| -------
| Any
|
| surfacecolor
| Sets the surface fill color.
|
| The 'surfacecolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y,z) triplet. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y,z) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatter3d.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatter3d.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zcalendar
| Sets the calendar system to use with `z` date data.
|
| The 'zcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattercarpet(plotly.basedatatypes.BaseTraceType)
| Scattercarpet(arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)
|
| Method resolution order:
| Scattercarpet
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, asrc=None, b=None, bsrc=None, carpet=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxis=None, yaxis=None, zorder=None, **kwargs)
| Construct a new Scattercarpet object
|
| Plots a scatter trace on either the first carpet axis or the
| carpet axis with a matching `carpet` attribute.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattercarpet`
| a
| Sets the a-axis coordinates.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the b-axis coordinates.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| carpet
| An identifier for this carpet, so that `scattercarpet`
| and `contourcarpet` traces can specify a carpet plot on
| which they lie
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattercarpet.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b). To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattercarpet.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattercarpet.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattercarpet.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattercarpet.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattercarpet.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (a,b) point. If
| a single string, the same string appears over all the
| data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattercarpet.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Scattercarpet
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| Sets the a-axis coordinates.
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| b
| Sets the b-axis coordinates.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| carpet
| An identifier for this carpet, so that `scattercarpet` and
| `contourcarpet` traces can specify a carpet plot on which they
| lie
|
| The 'carpet' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scatterternary has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['a', 'b', 'text', 'name'] joined with '+' characters
| (e.g. 'a+b')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (a,b) point. If a
| single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b). To be seen, trace `hoverinfo`
| must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattercarpet.mark
| er.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scattercarpet.mark
| er.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scattercarpet.mark
| er.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattercarpet.sele
| cted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattercarpet.sele
| cted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Stream
|
| text
| Sets text elements associated with each (a,b) point. If a
| single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b). If trace `hoverinfo` contains
| a "text" flag and "hovertext" is not set, these elements will
| be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `a`, `b`
| and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattercarpet.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattercarpet.unse
| lected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattercarpet.unse
| lected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scattercarpet.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattergeo(plotly.basedatatypes.BaseTraceType)
| Scattergeo(arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattergeo
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, featureidkey=None, fill=None, fillcolor=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, locationmode=None, locations=None, locationssrc=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattergeo object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattergeo`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| featureidkey
| Sets the key in GeoJSON features which is used as id to
| match the items included in the `locations` array. Only
| has an effect when `geojson` is set. Support nested
| property, for example "properties.name".
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| geo
| Sets a reference between this trace's geospatial
| coordinates and a geographic map. If "geo" (the default
| value), the geospatial coordinates refer to
| `layout.geo`. If "geo2", the geospatial coordinates
| refer to `layout.geo2`, and so on.
| geojson
| Sets optional GeoJSON data associated with this trace.
| If not given, the features on the base map are used
| when `locations` is set. It can be set as a valid
| GeoJSON object or as a URL string. Note that we only
| accept GeoJSONs of type "FeatureCollection" or
| "Feature" with geometries of type "Polygon" or
| "MultiPolygon".
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergeo.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair or item in `locations`. If a single string, the
| same string appears over all the data points. If an
| array of string, the items are mapped in order to the
| this trace's (lon,lat) or `locations` coordinates. To
| be seen, trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergeo.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergeo.Line` instance
| or dict with compatible properties
| locationmode
| Determines the set of locations used to match entries
| in `locations` to regions on the map. Values "ISO-3",
| "USA-states", *country names* correspond to features on
| the base map and value "geojson-id" corresponds to
| features from a custom GeoJSON linked to the `geojson`
| attribute.
| locations
| Sets the coordinates via location IDs or names.
| Coordinates correspond to the centroid of each location
| given. See `locationmode` for more info.
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattergeo.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergeo.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergeo.Stream`
| instance or dict with compatible properties
| text
| Sets text elements associated with each (lon,lat) pair
| or item in `locations`. If a single string, the same
| string appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (lon,lat) or `locations` coordinates. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is
| not set, these elements will be seen in the hover
| labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon`, `location` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergeo.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattergeo
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| featureidkey
| Sets the key in GeoJSON features which is used as id to match
| the items included in the `locations` array. Only has an effect
| when `geojson` is set. Support nested property, for example
| "properties.name".
|
| The 'featureidkey' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". "toself" connects the endpoints of the trace (or
| each segment of the trace if it has gaps) into a closed shape.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| geo
| Sets a reference between this trace's geospatial coordinates
| and a geographic map. If "geo" (the default value), the
| geospatial coordinates refer to `layout.geo`. If "geo2", the
| geospatial coordinates refer to `layout.geo2`, and so on.
|
| The 'geo' property is an identifier of a particular
| subplot, of type 'geo', that may be specified as the string 'geo'
| optionally followed by an integer >= 1
| (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.)
|
| Returns
| -------
| str
|
| geojson
| Sets optional GeoJSON data associated with this trace. If not
| given, the features on the base map are used when `locations`
| is set. It can be set as a valid GeoJSON object or as a URL
| string. Note that we only accept GeoJSONs of type
| "FeatureCollection" or "Feature" with geometries of type
| "Polygon" or "MultiPolygon".
|
| The 'geojson' property accepts values of any type
|
| Returns
| -------
| Any
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'location', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair or
| item in `locations`. If a single string, the same string
| appears over all the data points. If an array of string, the
| items are mapped in order to the this trace's (lon,lat) or
| `locations` coordinates. To be seen, trace `hoverinfo` must
| contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Line
|
| locationmode
| Determines the set of locations used to match entries in
| `locations` to regions on the map. Values "ISO-3", "USA-
| states", *country names* correspond to features on the base map
| and value "geojson-id" corresponds to features from a custom
| GeoJSON linked to the `geojson` attribute.
|
| The 'locationmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['ISO-3', 'USA-states', 'country names', 'geojson-id']
|
| Returns
| -------
| Any
|
| locations
| Sets the coordinates via location IDs or names. Coordinates
| correspond to the centroid of each location given. See
| `locationmode` for more info.
|
| The 'locations' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| locationssrc
| Sets the source reference on Chart Studio Cloud for
| `locations`.
|
| The 'locationssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| With "north", angle 0 points north based on the
| current map projection.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattergeo.marker.
| ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scattergeo.marker.
| Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scattergeo.marker.
| Line` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergeo.selecte
| d.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergeo.selecte
| d.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Stream
|
| text
| Sets text elements associated with each (lon,lat) pair or item
| in `locations`. If a single string, the same string appears
| over all the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat) or `locations`
| coordinates. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `lat`,
| `lon`, `location` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergeo.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergeo.unselec
| ted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergeo.unselec
| ted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergeo.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattergl(plotly.basedatatypes.BaseTraceType)
| Scattergl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)
|
| Method resolution order:
| Scattergl
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, **kwargs)
| Construct a new Scattergl object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattergl`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| error_x
| :class:`plotly.graph_objects.scattergl.ErrorX` instance
| or dict with compatible properties
| error_y
| :class:`plotly.graph_objects.scattergl.ErrorY` instance
| or dict with compatible properties
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattergl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattergl.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattergl.Line` instance
| or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattergl.Marker` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattergl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattergl.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattergl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
|
| Returns
| -------
| Scattergl
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| error_x
| The 'error_x' property is an instance of ErrorX
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.ErrorX`
| - A dict of string/value properties that will be passed
| to the ErrorX constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| copy_ystyle
|
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scattergl.ErrorX
|
| error_y
| The 'error_y' property is an instance of ErrorY
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.ErrorY`
| - A dict of string/value properties that will be passed
| to the ErrorY constructor
|
| Supported dict properties:
|
| array
| Sets the data corresponding the length of each
| error bar. Values are plotted relative to the
| underlying data.
| arrayminus
| Sets the data corresponding the length of each
| error bar in the bottom (left) direction for
| vertical (horizontal) bars Values are plotted
| relative to the underlying data.
| arrayminussrc
| Sets the source reference on Chart Studio Cloud
| for `arrayminus`.
| arraysrc
| Sets the source reference on Chart Studio Cloud
| for `array`.
| color
| Sets the stoke color of the error bars.
| symmetric
| Determines whether or not the error bars have
| the same length in both direction (top/bottom
| for vertical bars, left/right for horizontal
| bars.
| thickness
| Sets the thickness (in px) of the error bars.
| traceref
|
| tracerefminus
|
| type
| Determines the rule used to generate the error
| bars. If *constant`, the bar lengths are of a
| constant value. Set this constant in `value`.
| If "percent", the bar lengths correspond to a
| percentage of underlying data. Set this
| percentage in `value`. If "sqrt", the bar
| lengths correspond to the square of the
| underlying data. If "data", the bar lengths are
| set with data set `array`.
| value
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars.
| valueminus
| Sets the value of either the percentage (if
| `type` is set to "percent") or the constant (if
| `type` is set to "constant") corresponding to
| the lengths of the error bars in the bottom
| (left) direction for vertical (horizontal) bars
| visible
| Determines whether or not this set of error
| bars is visible.
| width
| Sets the width (in px) of the cross-bar at both
| ends of the error bars.
|
| Returns
| -------
| plotly.graph_objs.scattergl.ErrorY
|
| fill
| Sets the area to fill with a solid color. Defaults to "none"
| unless this trace is stacked, then it gets "tonexty"
| ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor`
| if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0
| respectively. "tonextx" and "tonexty" fill between the
| endpoints of this trace and the endpoints of the trace before
| it, connecting those endpoints with straight lines (to make a
| stacked area graph); if there is no trace before it, they
| behave like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if it has
| gaps) into a closed shape. "tonext" fills the space between two
| traces if one completely encloses the other (eg consecutive
| contour lines), and behaves like "toself" if there is no trace
| before it. "tonext" should not be used if one trace does not
| enclose the other. Traces in a `stackgroup` will only fill to
| (or be filled to) other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if fill-
| linked traces are not already consecutive, the later ones will
| be pushed down in the drawing order.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx',
| 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| dash
| Sets the style of the lines.
| shape
| Determines the line shape. The values
| correspond to step-wise line shapes.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattergl.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattergl.marker.C
| olorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.scattergl.marker.L
| ine` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergl.selected
| .Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergl.selected
| .Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergl.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattergl.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattergl.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattergl.unselect
| ed.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattergl.unselect
| ed.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattergl.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattermap(plotly.basedatatypes.BaseTraceType)
| Scattermap(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattermap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattermap object
|
| The data visualized as scatter point, lines or marker symbols
| on a MapLibre GL geographic map is provided by
| longitude/latitude pairs in `lon` and `lat`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattermap`
| below
| Determines if this scattermap trace's layers are to be
| inserted before the layer with the specified ID. By
| default, scattermap layers are inserted above all the
| base layers. To place the scattermap layers above every
| other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermap.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermap.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermap.Line` instance
| or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermap.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermap.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermap.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a map subplot. If "map" (the default value), the
| data refer to `layout.map`. If "map2", the data refer
| to `layout.map2`, and so on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=map.layer.paint.text-
| color, size=map.layer.layout.text-size). Has an effect
| only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermap.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattermap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| below
| Determines if this scattermap trace's layers are to be inserted
| before the layer with the specified ID. By default, scattermap
| layers are inserted above all the base layers. To place the
| scattermap layers above every other layer, set `below` to "''".
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cluster
| The 'cluster' property is an instance of Cluster
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Cluster`
| - A dict of string/value properties that will be passed
| to the Cluster constructor
|
| Supported dict properties:
|
| color
| Sets the color for each cluster step.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| enabled
| Determines whether clustering is enabled or
| disabled.
| maxzoom
| Sets the maximum zoom level. At zoom levels
| equal to or greater than this, points will
| never be clustered.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| size
| Sets the size for each cluster step.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| step
| Sets how many points it takes to create a
| cluster or advance to the next cluster step.
| Use this in conjunction with arrays for `size`
| and / or `color`. If an integer, steps start at
| multiples of this number. If an array, each
| step extends from the given value until one
| less than the next value.
| stepsrc
| Sets the source reference on Chart Studio Cloud
| for `step`.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Cluster
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". "toself" connects the endpoints of the trace (or
| each segment of the trace if it has gaps) into a closed shape.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattermap.Line
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| allowoverlap
| Flag to draw all symbols, even if they overlap.
| angle
| Sets the marker orientation from true North, in
| degrees clockwise. When using the "auto"
| default, no rotation would be applied in
| perspective views which is different from using
| a zero angle.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattermap.marker.
| ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol. Full list:
| https://www.map.com/maki-icons/ Note that the
| array `marker.color` and `marker.size` are only
| available for "circle" symbols.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermap.selecte
| d.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermap.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| map subplot. If "map" (the default value), the data refer to
| `layout.map`. If "map2", the data refer to `layout.map2`, and
| so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'map', that may be specified as the string 'map'
| optionally followed by an integer >= 1
| (e.g. 'map', 'map1', 'map2', 'map3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the icon text font (color=map.layer.paint.text-color,
| size=map.layer.layout.text-size). Has an effect only when
| `type` is set to "symbol".
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.scattermap.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `lat`,
| `lon` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermap.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermap.unselec
| ted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermap.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattermapbox(plotly.basedatatypes.BaseTraceType)
| Scattermapbox(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattermapbox
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, lat=None, latsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattermapbox object
|
| "scattermapbox" trace is deprecated! Please consider switching
| to the "scattermap" trace type and `map` subplots. Learn more
| at: https://plotly.com/javascript/maplibre-migration/ The data
| visualized as scatter point, lines or marker symbols on a
| Mapbox GL geographic map is provided by longitude/latitude
| pairs in `lon` and `lat`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattermapbox`
| below
| Determines if this scattermapbox trace's layers are to
| be inserted before the layer with the specified ID. By
| default, scattermapbox layers are inserted above all
| the base layers. To place the scattermapbox layers
| above every other layer, set `below` to "''".
| cluster
| :class:`plotly.graph_objects.scattermapbox.Cluster`
| instance or dict with compatible properties
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattermapbox.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (lon,lat)
| pair If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (lon,lat)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| lat
| Sets the latitude coordinates (in degrees North).
| latsrc
| Sets the source reference on Chart Studio Cloud for
| `lat`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattermapbox.Legendgroupt
| itle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattermapbox.Line`
| instance or dict with compatible properties
| lon
| Sets the longitude coordinates (in degrees East).
| lonsrc
| Sets the source reference on Chart Studio Cloud for
| `lon`.
| marker
| :class:`plotly.graph_objects.scattermapbox.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scattermapbox.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattermapbox.Stream`
| instance or dict with compatible properties
| subplot
| mapbox subplots and traces are deprecated! Please
| consider switching to `map` subplots and traces. Learn
| more at: https://plotly.com/javascript/maplibre-
| migration/ Sets a reference between this trace's data
| coordinates and a mapbox subplot. If "mapbox" (the
| default value), the data refer to `layout.mapbox`. If
| "mapbox2", the data refer to `layout.mapbox2`, and so
| on.
| text
| Sets text elements associated with each (lon,lat) pair
| If a single string, the same string appears over all
| the data points. If an array of string, the items are
| mapped in order to the this trace's (lon,lat)
| coordinates. If trace `hoverinfo` contains a "text"
| flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-
| color, size=mapbox.layer.layout.text-size). Has an
| effect only when `type` is set to "symbol".
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `lat`, `lon` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattermapbox.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattermapbox
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| below
| Determines if this scattermapbox trace's layers are to be
| inserted before the layer with the specified ID. By default,
| scattermapbox layers are inserted above all the base layers. To
| place the scattermapbox layers above every other layer, set
| `below` to "''".
|
| The 'below' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| cluster
| The 'cluster' property is an instance of Cluster
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Cluster`
| - A dict of string/value properties that will be passed
| to the Cluster constructor
|
| Supported dict properties:
|
| color
| Sets the color for each cluster step.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| enabled
| Determines whether clustering is enabled or
| disabled.
| maxzoom
| Sets the maximum zoom level. At zoom levels
| equal to or greater than this, points will
| never be clustered.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| size
| Sets the size for each cluster step.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| step
| Sets how many points it takes to create a
| cluster or advance to the next cluster step.
| Use this in conjunction with arrays for `size`
| and / or `color`. If an integer, steps start at
| multiples of this number. If an array, each
| step extends from the given value until one
| less than the next value.
| stepsrc
| Sets the source reference on Chart Studio Cloud
| for `step`.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Cluster
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". "toself" connects the endpoints of the trace (or
| each segment of the trace if it has gaps) into a closed shape.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters
| (e.g. 'lon+lat')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (lon,lat) pair If
| a single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| lat
| Sets the latitude coordinates (in degrees North).
|
| The 'lat' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| latsrc
| Sets the source reference on Chart Studio Cloud for `lat`.
|
| The 'latsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Line
|
| lon
| Sets the longitude coordinates (in degrees East).
|
| The 'lon' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| lonsrc
| Sets the source reference on Chart Studio Cloud for `lon`.
|
| The 'lonsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| allowoverlap
| Flag to draw all symbols, even if they overlap.
| angle
| Sets the marker orientation from true North, in
| degrees clockwise. When using the "auto"
| default, no rotation would be applied in
| perspective views which is different from using
| a zero angle.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattermapbox.mark
| er.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol. Full list:
| https://www.mapbox.com/maki-icons/ Note that
| the array `marker.color` and `marker.size` are
| only available for "circle" symbols.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover.
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermapbox.sele
| cted.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Stream
|
| subplot
| mapbox subplots and traces are deprecated! Please consider
| switching to `map` subplots and traces. Learn more at:
| https://plotly.com/javascript/maplibre-migration/ Sets a
| reference between this trace's data coordinates and a mapbox
| subplot. If "mapbox" (the default value), the data refer to
| `layout.mapbox`. If "mapbox2", the data refer to
| `layout.mapbox2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'mapbox', that may be specified as the string 'mapbox'
| optionally followed by an integer >= 1
| (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (lon,lat) pair If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (lon,lat) coordinates. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the icon text font (color=mapbox.layer.paint.text-color,
| size=mapbox.layer.layout.text-size). Has an effect only when
| `type` is set to "symbol".
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| size
|
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| weight
| Sets the weight (or boldness) of the font.
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `lat`,
| `lon` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattermapbox.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattermapbox.unse
| lected.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattermapbox.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatterpolar(plotly.basedatatypes.BaseTraceType)
| Scatterpolar(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scatterpolar
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scatterpolar object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scatterpolar`
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterpolar has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolar.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolar.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolar.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolar.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolar.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolar.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolar.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scatterpolar
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dr
| Sets the r coordinate step.
|
| The 'dr' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dtheta
| Sets the theta coordinate step. By default, the `dtheta` step
| equals the subplot's period divided by the length of the `r`
| coordinates.
|
| The 'dtheta' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scatterpolar has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters
| (e.g. 'r+theta')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatterpolar.marke
| r.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scatterpolar.marke
| r.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scatterpolar.marke
| r.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| r
| Sets the radial coordinates
|
| The 'r' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| r0
| Alternate to `r`. Builds a linear space of r coordinates. Use
| with `dr` where `r0` is the starting coordinate and `dr` the
| step.
|
| The 'r0' property accepts values of any type
|
| Returns
| -------
| Any
|
| rsrc
| Sets the source reference on Chart Studio Cloud for `r`.
|
| The 'rsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolar.selec
| ted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterpolar.selec
| ted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| polar subplot. If "polar" (the default value), the data refer
| to `layout.polar`. If "polar2", the data refer to
| `layout.polar2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'polar', that may be specified as the string 'polar'
| optionally followed by an integer >= 1
| (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `r`,
| `theta` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| theta
| Sets the angular coordinates
|
| The 'theta' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the starting
| coordinate and `dtheta` the step.
|
| The 'theta0' property accepts values of any type
|
| Returns
| -------
| Any
|
| thetasrc
| Sets the source reference on Chart Studio Cloud for `theta`.
|
| The 'thetasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| thetaunit
| Sets the unit of input "theta" values. Has an effect only when
| on "linear" angular axes.
|
| The 'thetaunit' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['radians', 'degrees', 'gradians']
|
| Returns
| -------
| Any
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolar.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolar.unsel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterpolar.unsel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolar.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatterpolargl(plotly.basedatatypes.BaseTraceType)
| Scatterpolargl(arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scatterpolargl
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, connectgaps=None, customdata=None, customdatasrc=None, dr=None, dtheta=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, r=None, r0=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, theta=None, theta0=None, thetasrc=None, thetaunit=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scatterpolargl object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Scatterpolargl`
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| dr
| Sets the r coordinate step.
| dtheta
| Sets the theta coordinate step. By default, the
| `dtheta` step equals the subplot's period divided by
| the length of the `r` coordinates.
| fill
| Sets the area to fill with a solid color. Defaults to
| "none" unless this trace is stacked, then it gets
| "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
| with `fillcolor` if not "none". "tozerox" and "tozeroy"
| fill to x=0 and y=0 respectively. "tonextx" and
| "tonexty" fill between the endpoints of this trace and
| the endpoints of the trace before it, connecting those
| endpoints with straight lines (to make a stacked area
| graph); if there is no trace before it, they behave
| like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other. Traces in a `stackgroup` will only fill to (or
| be filled to) other traces in the same group. With
| multiple `stackgroup`s or some traces stacked and some
| not, if fill-linked traces are not already consecutive,
| the later ones will be pushed down in the drawing
| order.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterpolargl.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterpolargl.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterpolargl.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterpolargl.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| r
| Sets the radial coordinates
| r0
| Alternate to `r`. Builds a linear space of r
| coordinates. Use with `dr` where `r0` is the starting
| coordinate and `dr` the step.
| rsrc
| Sets the source reference on Chart Studio Cloud for
| `r`.
| selected
| :class:`plotly.graph_objects.scatterpolargl.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterpolargl.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a polar subplot. If "polar" (the default value),
| the data refer to `layout.polar`. If "polar2", the data
| refer to `layout.polar2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `r`, `theta` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| theta
| Sets the angular coordinates
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the
| starting coordinate and `dtheta` the step.
| thetasrc
| Sets the source reference on Chart Studio Cloud for
| `theta`.
| thetaunit
| Sets the unit of input "theta" values. Has an effect
| only when on "linear" angular axes.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterpolargl.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scatterpolargl
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| dr
| Sets the r coordinate step.
|
| The 'dr' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dtheta
| Sets the theta coordinate step. By default, the `dtheta` step
| equals the subplot's period divided by the length of the `r`
| coordinates.
|
| The 'dtheta' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| fill
| Sets the area to fill with a solid color. Defaults to "none"
| unless this trace is stacked, then it gets "tonexty"
| ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor`
| if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0
| respectively. "tonextx" and "tonexty" fill between the
| endpoints of this trace and the endpoints of the trace before
| it, connecting those endpoints with straight lines (to make a
| stacked area graph); if there is no trace before it, they
| behave like "tozerox" and "tozeroy". "toself" connects the
| endpoints of the trace (or each segment of the trace if it has
| gaps) into a closed shape. "tonext" fills the space between two
| traces if one completely encloses the other (eg consecutive
| contour lines), and behaves like "toself" if there is no trace
| before it. "tonext" should not be used if one trace does not
| enclose the other. Traces in a `stackgroup` will only fill to
| (or be filled to) other traces in the same group. With multiple
| `stackgroup`s or some traces stacked and some not, if fill-
| linked traces are not already consecutive, the later ones will
| be pushed down in the drawing order.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx',
| 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters
| (e.g. 'r+theta')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the line color.
| dash
| Sets the style of the lines.
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatterpolargl.mar
| ker.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.scatterpolargl.mar
| ker.Line` instance or dict with compatible
| properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| r
| Sets the radial coordinates
|
| The 'r' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| r0
| Alternate to `r`. Builds a linear space of r coordinates. Use
| with `dr` where `r0` is the starting coordinate and `dr` the
| step.
|
| The 'r0' property accepts values of any type
|
| Returns
| -------
| Any
|
| rsrc
| Sets the source reference on Chart Studio Cloud for `r`.
|
| The 'rsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolargl.sel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterpolargl.sel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| polar subplot. If "polar" (the default value), the data refer
| to `layout.polar`. If "polar2", the data refer to
| `layout.polar2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'polar', that may be specified as the string 'polar'
| optionally followed by an integer >= 1
| (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `r`,
| `theta` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| theta
| Sets the angular coordinates
|
| The 'theta' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| theta0
| Alternate to `theta`. Builds a linear space of theta
| coordinates. Use with `dtheta` where `theta0` is the starting
| coordinate and `dtheta` the step.
|
| The 'theta0' property accepts values of any type
|
| Returns
| -------
| Any
|
| thetasrc
| Sets the source reference on Chart Studio Cloud for `theta`.
|
| The 'thetasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| thetaunit
| Sets the unit of input "theta" values. Has an effect only when
| on "linear" angular axes.
|
| The 'thetaunit' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['radians', 'degrees', 'gradians']
|
| Returns
| -------
| Any
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterpolargl.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterpolargl.uns
| elected.Marker` instance or dict with
| compatible properties
| textfont
| :class:`plotly.graph_objects.scatterpolargl.uns
| elected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterpolargl.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scattersmith(plotly.basedatatypes.BaseTraceType)
| Scattersmith(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scattersmith
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, imag=None, imagsrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, real=None, realsrc=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scattersmith object
|
| The scattersmith trace type encompasses line charts, scatter
| charts, text charts, and bubble charts in smith coordinates.
| The data visualized as scatter point or lines is set in `real`
| and `imag` (imaginary) coordinates Text (appearing either on
| the chart or on hover only) is via `text`. Bubble charts are
| achieved by setting `marker.size` and/or `marker.color` to
| numerical arrays.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Scattersmith`
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scattersmith has a subset of
| the options available to scatter. "toself" connects the
| endpoints of the trace (or each segment of the trace if
| it has gaps) into a closed shape. "tonext" fills the
| space between two traces if one completely encloses the
| other (eg consecutive contour lines), and behaves like
| "toself" if there is no trace before it. "tonext"
| should not be used if one trace does not enclose the
| other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scattersmith.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| imagsrc
| Sets the source reference on Chart Studio Cloud for
| `imag`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scattersmith.Legendgroupti
| tle` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scattersmith.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scattersmith.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| real
| Sets the real component of the data, in units of
| normalized impedance such that real=1, imag=0 is the
| center of the chart.
| realsrc
| Sets the source reference on Chart Studio Cloud for
| `real`.
| selected
| :class:`plotly.graph_objects.scattersmith.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scattersmith.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a smith subplot. If "smith" (the default value),
| the data refer to `layout.smith`. If "smith2", the data
| refer to `layout.smith2`, and so on.
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `real`, `imag` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scattersmith.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scattersmith
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scattersmith has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['real', 'imag', 'text', 'name'] joined with '+' characters
| (e.g. 'real+imag')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| imag
| Sets the imaginary component of the data, in units of
| normalized impedance such that real=1, imag=0 is the center of
| the chart.
|
| The 'imag' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| imagsrc
| Sets the source reference on Chart Studio Cloud for `imag`.
|
| The 'imagsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scattersmith.marke
| r.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scattersmith.marke
| r.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scattersmith.marke
| r.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| real
| Sets the real component of the data, in units of normalized
| impedance such that real=1, imag=0 is the center of the chart.
|
| The 'real' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| realsrc
| Sets the source reference on Chart Studio Cloud for `real`.
|
| The 'realsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattersmith.selec
| ted.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattersmith.selec
| ted.Textfont` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| smith subplot. If "smith" (the default value), the data refer
| to `layout.smith`. If "smith2", the data refer to
| `layout.smith2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'smith', that may be specified as the string 'smith'
| optionally followed by an integer >= 1
| (e.g. 'smith', 'smith1', 'smith2', 'smith3', etc.)
|
| Returns
| -------
| str
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `real`,
| `imag` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scattersmith.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scattersmith.unsel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scattersmith.unsel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scattersmith.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scatterternary(plotly.basedatatypes.BaseTraceType)
| Scatterternary(arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
|
| Method resolution order:
| Scatterternary
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, a=None, asrc=None, b=None, bsrc=None, c=None, cliponaxis=None, connectgaps=None, csrc=None, customdata=None, customdatasrc=None, fill=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, sum=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)
| Construct a new Scatterternary object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of
| :class:`plotly.graph_objs.Scatterternary`
| a
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| asrc
| Sets the source reference on Chart Studio Cloud for
| `a`.
| b
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| bsrc
| Sets the source reference on Chart Studio Cloud for
| `b`.
| c
| Sets the quantity of component `a` in each data point.
| If `a`, `b`, and `c` are all provided, they need not be
| normalized, only the relative values matter. If only
| two arrays are provided they must be normalized to
| match `ternary<i>.sum`.
| cliponaxis
| Determines whether or not markers and text nodes are
| clipped about the subplot axes. To show markers and
| text nodes above axis lines and tick labels, make sure
| to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the provided data arrays are connected.
| csrc
| Sets the source reference on Chart Studio Cloud for
| `c`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fill
| Sets the area to fill with a solid color. Use with
| `fillcolor` if not "none". scatterternary has a subset
| of the options available to scatter. "toself" connects
| the endpoints of the trace (or each segment of the
| trace if it has gaps) into a closed shape. "tonext"
| fills the space between two traces if one completely
| encloses the other (eg consecutive contour lines), and
| behaves like "toself" if there is no trace before it.
| "tonext" should not be used if one trace does not
| enclose the other.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.scatterternary.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual points
| (markers or line points) or do they highlight filled
| regions? If the fill is "toself" or "tonext" and there
| are no markers or text, then the default is "fills",
| otherwise it is "points".
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (a,b,c)
| point. If a single string, the same string appears over
| all the data points. If an array of strings, the items
| are mapped in order to the the data points in (a,b,c).
| To be seen, trace `hoverinfo` must contain a "text"
| flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.scatterternary.Legendgroup
| title` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.scatterternary.Line`
| instance or dict with compatible properties
| marker
| :class:`plotly.graph_objects.scatterternary.Marker`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| mode
| Determines the drawing mode for this scatter trace. If
| the provided `mode` includes "text" then the `text`
| elements appear at the coordinates. Otherwise, the
| `text` elements appear on hover. If there are less than
| 20 points and the trace is not stacked then the default
| is "lines+markers". Otherwise, "lines".
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.scatterternary.Selected`
| instance or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.scatterternary.Stream`
| instance or dict with compatible properties
| subplot
| Sets a reference between this trace's data coordinates
| and a ternary subplot. If "ternary" (the default
| value), the data refer to `layout.ternary`. If
| "ternary2", the data refer to `layout.ternary2`, and so
| on.
| sum
| The number each triplet should sum to, if only two of
| `a`, `b`, and `c` are provided. This overrides
| `ternary<i>.sum` to normalize this specific trace, but
| does not affect the values displayed on the axes. 0 (or
| missing) means to use ternary<i>.sum
| text
| Sets text elements associated with each (a,b,c) point.
| If a single string, the same string appears over all
| the data points. If an array of strings, the items are
| mapped in order to the the data points in (a,b,c). If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textfont
| Sets the text font.
| textposition
| Sets the positions of the `text` elements with respects
| to the (x,y) coordinates.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `a`, `b`, `c` and `text`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.scatterternary.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Scatterternary
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| a
| Sets the quantity of component `a` in each data point. If `a`,
| `b`, and `c` are all provided, they need not be normalized,
| only the relative values matter. If only two arrays are
| provided they must be normalized to match `ternary<i>.sum`.
|
| The 'a' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| asrc
| Sets the source reference on Chart Studio Cloud for `a`.
|
| The 'asrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| b
| Sets the quantity of component `a` in each data point. If `a`,
| `b`, and `c` are all provided, they need not be normalized,
| only the relative values matter. If only two arrays are
| provided they must be normalized to match `ternary<i>.sum`.
|
| The 'b' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| bsrc
| Sets the source reference on Chart Studio Cloud for `b`.
|
| The 'bsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| c
| Sets the quantity of component `a` in each data point. If `a`,
| `b`, and `c` are all provided, they need not be normalized,
| only the relative values matter. If only two arrays are
| provided they must be normalized to match `ternary<i>.sum`.
|
| The 'c' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| cliponaxis
| Determines whether or not markers and text nodes are clipped
| about the subplot axes. To show markers and text nodes above
| axis lines and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the provided data arrays are connected.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| csrc
| Sets the source reference on Chart Studio Cloud for `c`.
|
| The 'csrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fill
| Sets the area to fill with a solid color. Use with `fillcolor`
| if not "none". scatterternary has a subset of the options
| available to scatter. "toself" connects the endpoints of the
| trace (or each segment of the trace if it has gaps) into a
| closed shape. "tonext" fills the space between two traces if
| one completely encloses the other (eg consecutive contour
| lines), and behaves like "toself" if there is no trace before
| it. "tonext" should not be used if one trace does not enclose
| the other.
|
| The 'fill' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['none', 'toself', 'tonext']
|
| Returns
| -------
| Any
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['a', 'b', 'c', 'text', 'name'] joined with '+' characters
| (e.g. 'a+b')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual points (markers or
| line points) or do they highlight filled regions? If the fill
| is "toself" or "tonext" and there are no markers or text, then
| the default is "fills", otherwise it is "points".
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['points', 'fills'] joined with '+' characters
| (e.g. 'points+fills')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (a,b,c) point. If
| a single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b,c). To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| backoff
| Sets the line back off from the end point of
| the nth line segment (in px). This option is
| useful e.g. to avoid overlap with arrowhead
| markers. With "auto" the lines would trim
| before markers if `marker.angleref` is set to
| "previous".
| backoffsrc
| Sets the source reference on Chart Studio Cloud
| for `backoff`.
| color
| Sets the line color.
| dash
| Sets the dash style of lines. Set to a dash
| type string ("solid", "dot", "dash",
| "longdash", "dashdot", or "longdashdot") or a
| dash length list in px (eg "5px,10px,2px,2px").
| shape
| Determines the line shape. With "spline" the
| lines are drawn using spline interpolation. The
| other available values correspond to step-wise
| line shapes.
| smoothing
| Has an effect only if `shape` is set to
| "spline" Sets the amount of smoothing. 0
| corresponds to no smoothing (equivalent to a
| "linear" shape).
| width
| Sets the line width (in px).
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| angleref
| Sets the reference for marker angle. With
| "previous", angle 0 points along the line from
| the previous point to this one. With "up",
| angle 0 points toward the top of the screen.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.scatterternary.mar
| ker.ColorBar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| gradient
| :class:`plotly.graph_objects.scatterternary.mar
| ker.Gradient` instance or dict with compatible
| properties
| line
| :class:`plotly.graph_objects.scatterternary.mar
| ker.Line` instance or dict with compatible
| properties
| maxdisplayed
| Sets a maximum number of points to be drawn on
| the graph. 0 corresponds to no limit.
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| standoff
| Moves the marker away from the data point in
| the direction of `angle` (in px). This can be
| useful for example if you have another marker
| at this location and you want to point an
| arrowhead marker at it.
| standoffsrc
| Sets the source reference on Chart Studio Cloud
| for `standoff`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| mode
| Determines the drawing mode for this scatter trace. If the
| provided `mode` includes "text" then the `text` elements appear
| at the coordinates. Otherwise, the `text` elements appear on
| hover. If there are less than 20 points and the trace is not
| stacked then the default is "lines+markers". Otherwise,
| "lines".
|
| The 'mode' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['lines', 'markers', 'text'] joined with '+' characters
| (e.g. 'lines+markers')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterternary.sel
| ected.Marker` instance or dict with compatible
| properties
| textfont
| :class:`plotly.graph_objects.scatterternary.sel
| ected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Stream
|
| subplot
| Sets a reference between this trace's data coordinates and a
| ternary subplot. If "ternary" (the default value), the data
| refer to `layout.ternary`. If "ternary2", the data refer to
| `layout.ternary2`, and so on.
|
| The 'subplot' property is an identifier of a particular
| subplot, of type 'ternary', that may be specified as the string 'ternary'
| optionally followed by an integer >= 1
| (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.)
|
| Returns
| -------
| str
|
| sum
| The number each triplet should sum to, if only two of `a`, `b`,
| and `c` are provided. This overrides `ternary<i>.sum` to
| normalize this specific trace, but does not affect the values
| displayed on the axes. 0 (or missing) means to use
| ternary<i>.sum
|
| The 'sum' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| text
| Sets text elements associated with each (a,b,c) point. If a
| single string, the same string appears over all the data
| points. If an array of strings, the items are mapped in order
| to the the data points in (a,b,c). If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set, these
| elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textfont
| Sets the text font.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Textfont
|
| textposition
| Sets the positions of the `text` elements with respects to the
| (x,y) coordinates.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `a`, `b`,
| `c` and `text`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.scatterternary.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.scatterternary.uns
| elected.Marker` instance or dict with
| compatible properties
| textfont
| :class:`plotly.graph_objects.scatterternary.uns
| elected.Textfont` instance or dict with
| compatible properties
|
| Returns
| -------
| plotly.graph_objs.scatterternary.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Scene(builtins.dict)
| Scene(*args, **kwargs)
|
| plotly.graph_objs.Scene is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Scene
|
| Method resolution order:
| Scene
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Scene is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.Scene
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Splom(plotly.basedatatypes.BaseTraceType)
| Splom(arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)
|
| Method resolution order:
| Splom
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, customdata=None, customdatasrc=None, diagonal=None, dimensions=None, dimensiondefaults=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, showlowerhalf=None, showupperhalf=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, xaxes=None, xhoverformat=None, yaxes=None, yhoverformat=None, **kwargs)
| Construct a new Splom object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Splom`
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| diagonal
| :class:`plotly.graph_objects.splom.Diagonal` instance
| or dict with compatible properties
| dimensions
| A tuple of
| :class:`plotly.graph_objects.splom.Dimension` instances
| or dicts with compatible properties
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the
| default property values to use for elements of
| splom.dimensions
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.splom.Hoverlabel` instance
| or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.splom.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| marker
| :class:`plotly.graph_objects.splom.Marker` instance or
| dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| selected
| :class:`plotly.graph_objects.splom.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showlowerhalf
| Determines whether or not subplots on the lower half
| from the diagonal are displayed.
| showupperhalf
| Determines whether or not subplots on the upper half
| from the diagonal are displayed.
| stream
| :class:`plotly.graph_objects.splom.Stream` instance or
| dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair to
| appear on hover. If a single string, the same string
| appears over all the data points. If an array of
| string, the items are mapped in order to the this
| trace's (x,y) coordinates.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.splom.Unselected` instance
| or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| xaxes
| Sets the list of x axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N xaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| yaxes
| Sets the list of y axes corresponding to dimensions of
| this splom trace. By default, a splom will match the
| first N yaxes where N is the number of input
| dimensions. Note that, in case where `diagonal.visible`
| is false and `showupperhalf` or `showlowerhalf` is
| false, this splom trace will generate one less x-axis
| and one less y-axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
|
| Returns
| -------
| Splom
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| diagonal
| The 'diagonal' property is an instance of Diagonal
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Diagonal`
| - A dict of string/value properties that will be passed
| to the Diagonal constructor
|
| Supported dict properties:
|
| visible
| Determines whether or not subplots on the
| diagonal are displayed.
|
| Returns
| -------
| plotly.graph_objs.splom.Diagonal
|
| dimensiondefaults
| When used in a template (as
| layout.template.data.splom.dimensiondefaults), sets the default
| property values to use for elements of splom.dimensions
|
| The 'dimensiondefaults' property is an instance of Dimension
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Dimension`
| - A dict of string/value properties that will be passed
| to the Dimension constructor
|
| Supported dict properties:
|
| Returns
| -------
| plotly.graph_objs.splom.Dimension
|
| dimensions
| The 'dimensions' property is a tuple of instances of
| Dimension that may be specified as:
| - A list or tuple of instances of plotly.graph_objs.splom.Dimension
| - A list or tuple of dicts of string/value properties that
| will be passed to the Dimension constructor
|
| Supported dict properties:
|
| axis
| :class:`plotly.graph_objects.splom.dimension.Ax
| is` instance or dict with compatible properties
| label
| Sets the label corresponding to this splom
| dimension.
| name
| When used in a template, named items are
| created in the output figure in addition to any
| items the figure already has in this array. You
| can modify these items in the output figure by
| making your own item with `templateitemname`
| matching this `name` alongside your
| modifications (including `visible: false` or
| `enabled: false` to hide it). Has no effect
| outside of a template.
| templateitemname
| Used to refer to a named item in this array in
| the template. Named items from the template
| will be created even without a matching item in
| the input figure, but you can modify one by
| making an item with `templateitemname` matching
| its `name`, alongside your modifications
| (including `visible: false` or `enabled: false`
| to hide it). If there is no template or no
| matching item, this item will be hidden unless
| you explicitly show it with `visible: true`.
| values
| Sets the dimension values to be plotted.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
| visible
| Determines whether or not this dimension is
| shown on the graph. Note that even visible
| false dimension contribute to the default grid
| generate by this splom trace.
|
| Returns
| -------
| tuple[plotly.graph_objs.splom.Dimension]
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.splom.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.splom.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| anglesrc
| Sets the source reference on Chart Studio Cloud
| for `angle`.
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if in `marker.color` is set to a
| numerical array. In case `colorscale` is
| unspecified or `autocolorscale` is true, the
| default palette will be chosen according to
| whether numbers in the `color` array are all
| positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| in `marker.color`) or the bounds set in
| `marker.cmin` and `marker.cmax` Has an effect
| only if in `marker.color` is set to a numerical
| array. Defaults to `false` when `marker.cmin`
| and `marker.cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if in `marker.color` is set to a numerical
| array. Value should have the same units as in
| `marker.color`. Has no effect when
| `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if in `marker.color` is set to a
| numerical array. Value should have the same
| units as in `marker.color` and if set,
| `marker.cmax` must be set as well.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.splom.marker.Color
| Bar` instance or dict with compatible
| properties
| colorscale
| Sets the colorscale. Has an effect only if in
| `marker.color` is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| line
| :class:`plotly.graph_objects.splom.marker.Line`
| instance or dict with compatible properties
| opacity
| Sets the marker opacity.
| opacitysrc
| Sets the source reference on Chart Studio Cloud
| for `opacity`.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if in `marker.color` is set to a
| numerical array. If true, `marker.cmin` will
| correspond to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| in `marker.color` is set to a numerical array.
| size
| Sets the marker size (in px).
| sizemin
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the minimum size (in px)
| of the rendered marker points.
| sizemode
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the rule for which the
| data in `size` is converted to pixels.
| sizeref
| Has an effect only if `marker.size` is set to a
| numerical array. Sets the scale factor used to
| determine the rendered size of marker points.
| Use with `sizemin` and `sizemode`.
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
| symbolsrc
| Sets the source reference on Chart Studio Cloud
| for `symbol`.
|
| Returns
| -------
| plotly.graph_objs.splom.Marker
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.splom.selected.Mar
| ker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.splom.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showlowerhalf
| Determines whether or not subplots on the lower half from the
| diagonal are displayed.
|
| The 'showlowerhalf' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showupperhalf
| Determines whether or not subplots on the upper half from the
| diagonal are displayed.
|
| The 'showupperhalf' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.splom.Stream
|
| text
| Sets text elements associated with each (x,y) pair to appear on
| hover. If a single string, the same string appears over all the
| data points. If an array of string, the items are mapped in
| order to the this trace's (x,y) coordinates.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.splom.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.splom.unselected.M
| arker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.splom.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| xaxes
| Sets the list of x axes corresponding to dimensions of this
| splom trace. By default, a splom will match the first N xaxes
| where N is the number of input dimensions. Note that, in case
| where `diagonal.visible` is false and `showupperhalf` or
| `showlowerhalf` is false, this splom trace will generate one
| less x-axis and one less y-axis.
|
| The 'xaxes' property is an info array that may be specified as:
| * a list of elements where:
| The 'xaxes[i]' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| list
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yaxes
| Sets the list of y axes corresponding to dimensions of this
| splom trace. By default, a splom will match the first N yaxes
| where N is the number of input dimensions. Note that, in case
| where `diagonal.visible` is false and `showupperhalf` or
| `showlowerhalf` is false, this splom trace will generate one
| less x-axis and one less y-axis.
|
| The 'yaxes' property is an info array that may be specified as:
| * a list of elements where:
| The 'yaxes[i]' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| list
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Stream(builtins.dict)
| Stream(*args, **kwargs)
|
| plotly.graph_objs.Stream is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Stream
| - plotly.graph_objs.area.Stream
|
| Method resolution order:
| Stream
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Stream is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.scatter.Stream
| - plotly.graph_objs.area.Stream
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Streamtube(plotly.basedatatypes.BaseTraceType)
| Streamtube(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Streamtube
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, maxdisplayed=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, sizeref=None, starts=None, stream=None, text=None, u=None, uhoverformat=None, uid=None, uirevision=None, usrc=None, v=None, vhoverformat=None, visible=None, vsrc=None, w=None, whoverformat=None, wsrc=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Streamtube object
|
| Use a streamtube trace to visualize flow in a vector field.
| Specify a vector field using 6 1D arrays of equal length, 3
| position arrays `x`, `y` and `z` and 3 vector component arrays
| `u`, `v`, and `w`. By default, the tubes' starting positions
| will be cut from the vector field's x-z plane at its minimum y
| value. To specify your own starting position, use attributes
| `starts.x`, `starts.y` and `starts.z`. The color is encoded by
| the norm of (u, v, w), and the local radius by the divergence
| of (u, v, w).
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Streamtube`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here u/v/w norm) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmin`
| must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as u/v/w norm. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as u/v/w norm and if set, `cmax`
| must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.streamtube.ColorBar`
| instance or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.streamtube.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `tubex`, `tubey`, `tubez`, `tubeu`,
| `tubev`, `tubew`, `norm` and `divergence`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.streamtube.Legendgrouptitl
| e` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.streamtube.Lighting`
| instance or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.streamtube.Lightposition`
| instance or dict with compatible properties
| maxdisplayed
| The maximum number of displayed segments in a
| streamtube.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| sizeref
| The scaling factor for the streamtubes. The default is
| 1, which avoids two max divergence tubes from touching
| at adjacent starting positions.
| starts
| :class:`plotly.graph_objects.streamtube.Starts`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.streamtube.Stream`
| instance or dict with compatible properties
| text
| Sets a text element associated with this trace. If
| trace `hoverinfo` contains a "text" flag, this text
| element will be seen in all hover labels. Note that
| streamtube traces do not support array `text` values.
| u
| Sets the x components of the vector field.
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| usrc
| Sets the source reference on Chart Studio Cloud for
| `u`.
| v
| Sets the y components of the vector field.
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| vsrc
| Sets the source reference on Chart Studio Cloud for
| `v`.
| w
| Sets the z components of the vector field.
| whoverformat
| Sets the hover text formatting rulefor `w` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| wsrc
| Sets the source reference on Chart Studio Cloud for
| `w`.
| x
| Sets the x coordinates of the vector field.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates of the vector field.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates of the vector field.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Streamtube
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here u/v/w norm) or the bounds set
| in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmin` must be set as
| well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as u/v/w norm. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as u/v/w norm and if set, `cmax` must be set as
| well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.streamt
| ube.colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.streamtube.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of streamtube.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.streamtube.colorba
| r.Title` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| streamtube.colorbar.title.font instead. Sets
| this color bar's title font. Note that the
| title's font used to be set by the now
| deprecated `titlefont` attribute.
| titleside
| Deprecated: Please use
| streamtube.colorbar.title.side instead.
| Determines the location of color bar's title
| with respect to the color bar. Defaults to
| "top" when `orientation` if "v" and defaults
| to "right" when `orientation` if "h". Note that
| the title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.streamtube.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `tubex`, `tubey`,
| `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Lightposition
|
| maxdisplayed
| The maximum number of displayed segments in a streamtube.
|
| The 'maxdisplayed' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
| in the interval [0, 9223372036854775807]
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| sizeref
| The scaling factor for the streamtubes. The default is 1, which
| avoids two max divergence tubes from touching at adjacent
| starting positions.
|
| The 'sizeref' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| starts
| The 'starts' property is an instance of Starts
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Starts`
| - A dict of string/value properties that will be passed
| to the Starts constructor
|
| Supported dict properties:
|
| x
| Sets the x components of the starting position
| of the streamtubes
| xsrc
| Sets the source reference on Chart Studio Cloud
| for `x`.
| y
| Sets the y components of the starting position
| of the streamtubes
| ysrc
| Sets the source reference on Chart Studio Cloud
| for `y`.
| z
| Sets the z components of the starting position
| of the streamtubes
| zsrc
| Sets the source reference on Chart Studio Cloud
| for `z`.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Starts
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.streamtube.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.streamtube.Stream
|
| text
| Sets a text element associated with this trace. If trace
| `hoverinfo` contains a "text" flag, this text element will be
| seen in all hover labels. Note that streamtube traces do not
| support array `text` values.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| u
| Sets the x components of the vector field.
|
| The 'u' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| uhoverformat
| Sets the hover text formatting rulefor `u` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'uhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| usrc
| Sets the source reference on Chart Studio Cloud for `u`.
|
| The 'usrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| v
| Sets the y components of the vector field.
|
| The 'v' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| vhoverformat
| Sets the hover text formatting rulefor `v` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'vhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| vsrc
| Sets the source reference on Chart Studio Cloud for `v`.
|
| The 'vsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| w
| Sets the z components of the vector field.
|
| The 'w' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| whoverformat
| Sets the hover text formatting rulefor `w` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'whoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| wsrc
| Sets the source reference on Chart Studio Cloud for `w`.
|
| The 'wsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates of the vector field.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates of the vector field.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates of the vector field.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Sunburst(plotly.basedatatypes.BaseTraceType)
| Sunburst(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Sunburst
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, root=None, rotation=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Sunburst object
|
| Visualize hierarchal data spanning outward radially from root
| to leaves. The sunburst sectors are determined by the entries
| in "labels" or "ids" and in "parents".
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Sunburst`
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.sunburst.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.sunburst.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| insidetextorientation
| Controls the orientation of the text inside chart
| sectors. When set to "auto", text may be oriented in
| any direction in order to be as big as possible in the
| middle of a sector. The "horizontal" option orients
| text to be parallel with the bottom of the chart, and
| may make text smaller in order to achieve that goal.
| The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text
| perpendicular to the radius of the sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| leaf
| :class:`plotly.graph_objects.sunburst.Leaf` instance or
| dict with compatible properties
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.sunburst.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.sunburst.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented at the center of a sunburst graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| root
| :class:`plotly.graph_objects.sunburst.Root` instance or
| dict with compatible properties
| rotation
| Rotates the whole diagram counterclockwise by some
| angle. By default the first slice starts at 3 o'clock.
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.sunburst.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Sunburst
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| branchvalues
| Determines how the items in `values` are summed. When set to
| "total", items in `values` are taken to be value of all its
| descendants. When set to "remainder", items in `values`
| corresponding to the root and the branches sectors are taken to
| be the extra part not part of the sum of the values at their
| leaves.
|
| The 'branchvalues' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['remainder', 'total']
|
| Returns
| -------
| Any
|
| count
| Determines default for `values` when it is not provided, by
| inferring a 1 for each of the "leaves" and/or "branches",
| otherwise 0.
|
| The 'count' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['branches', 'leaves'] joined with '+' characters
| (e.g. 'branches+leaves')
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this sunburst trace
| .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this sunburst trace .
| x
| Sets the horizontal domain of this sunburst
| trace (in plot fraction).
| y
| Sets the vertical domain of this sunburst trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.sunburst.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `currentPath`, `root`,
| `entry`, `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Insidetextfont
|
| insidetextorientation
| Controls the orientation of the text inside chart sectors. When
| set to "auto", text may be oriented in any direction in order
| to be as big as possible in the middle of a sector. The
| "horizontal" option orients text to be parallel with the bottom
| of the chart, and may make text smaller in order to achieve
| that goal. The "radial" option orients text along the radius of
| the sector. The "tangential" option orients text perpendicular
| to the radius of the sector.
|
| The 'insidetextorientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['horizontal', 'radial', 'tangential', 'auto']
|
| Returns
| -------
| Any
|
| labels
| Sets the labels of each of the sectors.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| leaf
| The 'leaf' property is an instance of Leaf
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Leaf`
| - A dict of string/value properties that will be passed
| to the Leaf constructor
|
| Supported dict properties:
|
| opacity
| Sets the opacity of the leaves. With colorscale
| it is defaulted to 1; otherwise it is defaulted
| to 0.7
|
| Returns
| -------
| plotly.graph_objs.sunburst.Leaf
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| level
| Sets the level from which this trace hierarchy is rendered. Set
| `level` to `''` to start from the root node in the hierarchy.
| Must be an "id" if `ids` is filled in, otherwise plotly
| attempts to find a matching item in `labels`.
|
| The 'level' property accepts values of any type
|
| Returns
| -------
| Any
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if colors is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| colors) or the bounds set in `marker.cmin` and
| `marker.cmax` Has an effect only if colors is
| set to a numerical array. Defaults to `false`
| when `marker.cmin` and `marker.cmax` are set by
| the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmin` must be set as
| well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if colors is set to a numerical array.
| Value should have the same units as colors. Has
| no effect when `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmax` must be set as
| well.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.sunburst.marker.Co
| lorBar` instance or dict with compatible
| properties
| colors
| Sets the color of each sector of this trace. If
| not specified, the default trace color set is
| used to pick the sector colors.
| colorscale
| Sets the colorscale. Has an effect only if
| colors is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| line
| :class:`plotly.graph_objects.sunburst.marker.Li
| ne` instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if colors is set to a numerical
| array. If true, `marker.cmin` will correspond
| to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| colors is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Marker
|
| maxdepth
| Sets the number of rendered sectors from any given `level`. Set
| `maxdepth` to "-1" to render all the levels in the hierarchy.
|
| The 'maxdepth' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
| This option refers to the root of the hierarchy presented at
| the center of a sunburst graph. Please note that if a hierarchy
| has multiple root nodes, this option won't have any effect and
| `insidetextfont` would be used.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Outsidetextfont
|
| parents
| Sets the parent sectors for each of the sectors. Empty string
| items '' are understood to reference the root node in the
| hierarchy. If `ids` is filled, `parents` items are understood
| to be "ids" themselves. When `ids` is not set, plotly attempts
| to find matching items in `labels`, but beware they must be
| unique.
|
| The 'parents' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| parentssrc
| Sets the source reference on Chart Studio Cloud for `parents`.
|
| The 'parentssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| root
| The 'root' property is an instance of Root
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Root`
| - A dict of string/value properties that will be passed
| to the Root constructor
|
| Supported dict properties:
|
| color
| sets the color of the root node for a
| sunburst/treemap/icicle trace. this has no
| effect when a colorscale is used to set the
| markers.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Root
|
| rotation
| Rotates the whole diagram counterclockwise by some angle. By
| default the first slice starts at 3 o'clock.
|
| The 'rotation' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.sunburst.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.sunburst.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
| `percentParent`, `label` and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values associated with each of the sectors. Use with
| `branchvalues` to determine how the values are summed.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Surface(plotly.basedatatypes.BaseTraceType)
| Surface(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Surface
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, hidesurface=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, surfacecolor=None, surfacecolorsrc=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Surface object
|
| The data the describes the coordinates of the surface is set in
| `z`. Data in `z` should be a 2D list. Coordinates in `x` and
| `y` can either be 1D lists or 2D lists (e.g. to graph
| parametric surfaces). If not provided in `x` and `y`, the x and
| y coordinates are assumed to be linear starting at 0 with a
| unit step. The color scale corresponds to the `z` values by
| default. For custom color scales, use `surfacecolor` which
| should be a 2D list, where its bounds can be controlled using
| `cmin` and `cmax`.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Surface`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here z or surfacecolor)
| or the bounds set in `cmin` and `cmax` Defaults to
| `false` when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmin` must be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as z or surfacecolor.
| Has no effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as z or surfacecolor and if set,
| `cmax` must be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.surface.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing
| values) in the `z` data are filled in.
| contours
| :class:`plotly.graph_objects.surface.Contours` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| hidesurface
| Determines whether or not a surface is drawn. For
| example, set `hidesurface` to False `contours.x.show`
| to True and `contours.y.show` to True to draw a wire
| frame plot.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.surface.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.surface.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.surface.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.surface.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| stream
| :class:`plotly.graph_objects.surface.Stream` instance
| or dict with compatible properties
| surfacecolor
| Sets the surface color values, used for setting a color
| scale independent of `z`.
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
| text
| Sets the text elements associated with each z value. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the x coordinates.
| xcalendar
| Sets the calendar system to use with `x` date data.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| ycalendar
| Sets the calendar system to use with `y` date data.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the z coordinates.
| zcalendar
| Sets the calendar system to use with `z` date data.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Surface
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here z or surfacecolor) or the
| bounds set in `cmin` and `cmax` Defaults to `false` when `cmin`
| and `cmax` are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as z or surfacecolor and if set, `cmin` must be set
| as well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as z or surfacecolor. Has no effect when `cauto` is
| `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as z or surfacecolor and if set, `cmax` must be set
| as well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.surface
| .colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.surface.colorbar.tickformatstopdefaults),
| sets the default property values to use for
| elements of surface.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.surface.colorbar.T
| itle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| surface.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| surface.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.surface.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| connectgaps
| Determines whether or not gaps (i.e. {nan} or missing values)
| in the `z` data are filled in.
|
| The 'connectgaps' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| contours
| The 'contours' property is an instance of Contours
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Contours`
| - A dict of string/value properties that will be passed
| to the Contours constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.surface.contours.X
| ` instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.surface.contours.Y
| ` instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.surface.contours.Z
| ` instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.surface.Contours
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hidesurface
| Determines whether or not a surface is drawn. For example, set
| `hidesurface` to False `contours.x.show` to True and
| `contours.y.show` to True to draw a wire frame plot.
|
| The 'hidesurface' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.surface.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.surface.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
|
| Returns
| -------
| plotly.graph_objs.surface.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.surface.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| opacityscale
| Sets the opacityscale. The opacityscale must be an array
| containing arrays mapping a normalized value to an opacity
| value. At minimum, a mapping for the lowest (0) and highest (1)
| values are required. For example, `[[0, 1], [0.5, 0.2], [1,
| 1]]` means that higher/lower values would have higher opacity
| values and those in the middle would be more transparent
| Alternatively, `opacityscale` may be a palette name string of
| the following list: 'min', 'max', 'extremes' and 'uniform'. The
| default is 'uniform'.
|
| The 'opacityscale' property accepts values of any type
|
| Returns
| -------
| Any
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.surface.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.surface.Stream
|
| surfacecolor
| Sets the surface color values, used for setting a color scale
| independent of `z`.
|
| The 'surfacecolor' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| surfacecolorsrc
| Sets the source reference on Chart Studio Cloud for
| `surfacecolor`.
|
| The 'surfacecolorsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| text
| Sets the text elements associated with each z value. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xcalendar
| Sets the calendar system to use with `x` date data.
|
| The 'xcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| ycalendar
| Sets the calendar system to use with `y` date data.
|
| The 'ycalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the z coordinates.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zcalendar
| Sets the calendar system to use with `z` date data.
|
| The 'zcalendar' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['chinese', 'coptic', 'discworld', 'ethiopian',
| 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
| 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
| 'thai', 'ummalqura']
|
| Returns
| -------
| Any
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Table(plotly.basedatatypes.BaseTraceType)
| Table(arg=None, cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)
|
| Method resolution order:
| Table
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, cells=None, columnorder=None, columnordersrc=None, columnwidth=None, columnwidthsrc=None, customdata=None, customdatasrc=None, domain=None, header=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, ids=None, idssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)
| Construct a new Table object
|
| 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
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Table`
| cells
| :class:`plotly.graph_objects.table.Cells` instance or
| dict with compatible properties
| columnorder
| Specifies the rendered order of the data columns; for
| example, a value `2` at position `0` means that column
| index `0` in the data will be rendered as the third
| column, as columns have an index base of zero.
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
| columnwidth
| The width of columns expressed as a ratio. Columns fill
| the available width in proportion of their specified
| column widths.
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.table.Domain` instance or
| dict with compatible properties
| header
| :class:`plotly.graph_objects.table.Header` instance or
| dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.table.Hoverlabel` instance
| or dict with compatible properties
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.table.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| stream
| :class:`plotly.graph_objects.table.Stream` instance or
| dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Table
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| cells
| The 'cells' property is an instance of Cells
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Cells`
| - A dict of string/value properties that will be passed
| to the Cells constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the `text`
| within the box. Has an effect only if `text`
| spans two or more lines (i.e. `text` contains
| one or more <br> HTML tags) or if an explicit
| width is set to override the text width.
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| fill
| :class:`plotly.graph_objects.table.cells.Fill`
| instance or dict with compatible properties
| font
| :class:`plotly.graph_objects.table.cells.Font`
| instance or dict with compatible properties
| format
| Sets the cell value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| formatsrc
| Sets the source reference on Chart Studio Cloud
| for `format`.
| height
| The height of cells.
| line
| :class:`plotly.graph_objects.table.cells.Line`
| instance or dict with compatible properties
| prefix
| Prefix for cell values.
| prefixsrc
| Sets the source reference on Chart Studio Cloud
| for `prefix`.
| suffix
| Suffix for cell values.
| suffixsrc
| Sets the source reference on Chart Studio Cloud
| for `suffix`.
| values
| Cell values. `values[m][n]` represents the
| value of the `n`th point in column `m`,
| therefore the `values[m]` vector length for all
| columns must be the same (longer vectors will
| be truncated). Each value must be a finite
| number or a string.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
|
| Returns
| -------
| plotly.graph_objs.table.Cells
|
| columnorder
| Specifies the rendered order of the data columns; for example,
| a value `2` at position `0` means that column index `0` in the
| data will be rendered as the third column, as columns have an
| index base of zero.
|
| The 'columnorder' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| columnordersrc
| Sets the source reference on Chart Studio Cloud for
| `columnorder`.
|
| The 'columnordersrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| columnwidth
| The width of columns expressed as a ratio. Columns fill the
| available width in proportion of their specified column widths.
|
| The 'columnwidth' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| columnwidthsrc
| Sets the source reference on Chart Studio Cloud for
| `columnwidth`.
|
| The 'columnwidthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this table trace .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this table trace .
| x
| Sets the horizontal domain of this table trace
| (in plot fraction).
| y
| Sets the vertical domain of this table trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.table.Domain
|
| header
| The 'header' property is an instance of Header
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Header`
| - A dict of string/value properties that will be passed
| to the Header constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the `text`
| within the box. Has an effect only if `text`
| spans two or more lines (i.e. `text` contains
| one or more <br> HTML tags) or if an explicit
| width is set to override the text width.
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| fill
| :class:`plotly.graph_objects.table.header.Fill`
| instance or dict with compatible properties
| font
| :class:`plotly.graph_objects.table.header.Font`
| instance or dict with compatible properties
| format
| Sets the cell value formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format.
| formatsrc
| Sets the source reference on Chart Studio Cloud
| for `format`.
| height
| The height of cells.
| line
| :class:`plotly.graph_objects.table.header.Line`
| instance or dict with compatible properties
| prefix
| Prefix for cell values.
| prefixsrc
| Sets the source reference on Chart Studio Cloud
| for `prefix`.
| suffix
| Suffix for cell values.
| suffixsrc
| Sets the source reference on Chart Studio Cloud
| for `suffix`.
| values
| Header cell values. `values[m][n]` represents
| the value of the `n`th point in column `m`,
| therefore the `values[m]` vector length for all
| columns must be the same (longer vectors will
| be truncated). Each value must be a finite
| number or a string.
| valuessrc
| Sets the source reference on Chart Studio Cloud
| for `values`.
|
| Returns
| -------
| plotly.graph_objs.table.Header
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.table.Hoverlabel
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.table.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.table.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.table.Stream
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Trace(builtins.dict)
| Trace(*args, **kwargs)
|
| plotly.graph_objs.Trace is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| Method resolution order:
| Trace
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.Trace is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.Scatter
| - plotly.graph_objs.Bar
| - plotly.graph_objs.Area
| - plotly.graph_objs.Histogram
| - etc.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class Treemap(plotly.basedatatypes.BaseTraceType)
| Treemap(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
|
| Method resolution order:
| Treemap
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)
| Construct a new Treemap object
|
| Visualize hierarchal data from leaves (and/or outer branches)
| towards root with rectangles. The treemap sectors are
| determined by the entries in "labels" or "ids" and in
| "parents".
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Treemap`
| branchvalues
| Determines how the items in `values` are summed. When
| set to "total", items in `values` are taken to be value
| of all its descendants. When set to "remainder", items
| in `values` corresponding to the root and the branches
| sectors are taken to be the extra part not part of the
| sum of the values at their leaves.
| count
| Determines default for `values` when it is not
| provided, by inferring a 1 for each of the "leaves"
| and/or "branches", otherwise 0.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| domain
| :class:`plotly.graph_objects.treemap.Domain` instance
| or dict with compatible properties
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.treemap.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each sector.
| If a single string, the same string appears for all
| data points. If an array of string, the items are
| mapped in order of this trace's sectors. To be seen,
| trace `hoverinfo` must contain a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| insidetextfont
| Sets the font used for `textinfo` lying inside the
| sector.
| labels
| Sets the labels of each of the sectors.
| labelssrc
| Sets the source reference on Chart Studio Cloud for
| `labels`.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgrouptitle
| :class:`plotly.graph_objects.treemap.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| level
| Sets the level from which this trace hierarchy is
| rendered. Set `level` to `''` to start from the root
| node in the hierarchy. Must be an "id" if `ids` is
| filled in, otherwise plotly attempts to find a matching
| item in `labels`.
| marker
| :class:`plotly.graph_objects.treemap.Marker` instance
| or dict with compatible properties
| maxdepth
| Sets the number of rendered sectors from any given
| `level`. Set `maxdepth` to "-1" to render all the
| levels in the hierarchy.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the trace.
| outsidetextfont
| Sets the font used for `textinfo` lying outside the
| sector. This option refers to the root of the hierarchy
| presented on top left corner of a treemap graph. Please
| note that if a hierarchy has multiple root nodes, this
| option won't have any effect and `insidetextfont` would
| be used.
| parents
| Sets the parent sectors for each of the sectors. Empty
| string items '' are understood to reference the root
| node in the hierarchy. If `ids` is filled, `parents`
| items are understood to be "ids" themselves. When `ids`
| is not set, plotly attempts to find matching items in
| `labels`, but beware they must be unique.
| parentssrc
| Sets the source reference on Chart Studio Cloud for
| `parents`.
| pathbar
| :class:`plotly.graph_objects.treemap.Pathbar` instance
| or dict with compatible properties
| root
| :class:`plotly.graph_objects.treemap.Root` instance or
| dict with compatible properties
| sort
| Determines whether or not the sectors are reordered
| from largest to smallest.
| stream
| :class:`plotly.graph_objects.treemap.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each sector. If
| trace `textinfo` contains a "text" flag, these elements
| will be seen on the chart. If trace `hoverinfo`
| contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
| textfont
| Sets the font used for `textinfo`.
| textinfo
| Determines which trace information appear on the graph.
| textposition
| Sets the positions of the `text` elements.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `currentPath`, `root`, `entry`,
| `percentRoot`, `percentEntry`, `percentParent`, `label`
| and `value`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| tiling
| :class:`plotly.graph_objects.treemap.Tiling` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| values
| Sets the values associated with each of the sectors.
| Use with `branchvalues` to determine how the values are
| summed.
| valuessrc
| Sets the source reference on Chart Studio Cloud for
| `values`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
|
| Returns
| -------
| Treemap
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| branchvalues
| Determines how the items in `values` are summed. When set to
| "total", items in `values` are taken to be value of all its
| descendants. When set to "remainder", items in `values`
| corresponding to the root and the branches sectors are taken to
| be the extra part not part of the sum of the values at their
| leaves.
|
| The 'branchvalues' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['remainder', 'total']
|
| Returns
| -------
| Any
|
| count
| Determines default for `values` when it is not provided, by
| inferring a 1 for each of the "leaves" and/or "branches",
| otherwise 0.
|
| The 'count' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['branches', 'leaves'] joined with '+' characters
| (e.g. 'branches+leaves')
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| domain
| The 'domain' property is an instance of Domain
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Domain`
| - A dict of string/value properties that will be passed
| to the Domain constructor
|
| Supported dict properties:
|
| column
| If there is a layout grid, use the domain for
| this column in the grid for this treemap trace
| .
| row
| If there is a layout grid, use the domain for
| this row in the grid for this treemap trace .
| x
| Sets the horizontal domain of this treemap
| trace (in plot fraction).
| y
| Sets the vertical domain of this treemap trace
| (in plot fraction).
|
| Returns
| -------
| plotly.graph_objs.treemap.Domain
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `currentPath`, `root`,
| `entry`, `percentRoot`, `percentEntry` and `percentParent`.
| Anything contained in tag `<extra>` is displayed in the
| secondary box, for example "<extra>{fullData.name}</extra>". To
| hide the secondary box completely, use an empty tag
| `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each sector. If a
| single string, the same string appears for all data points. If
| an array of string, the items are mapped in order of this
| trace's sectors. To be seen, trace `hoverinfo` must contain a
| "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| insidetextfont
| Sets the font used for `textinfo` lying inside the sector.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Insidetextfont
|
| labels
| Sets the labels of each of the sectors.
|
| The 'labels' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| labelssrc
| Sets the source reference on Chart Studio Cloud for `labels`.
|
| The 'labelssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.treemap.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| level
| Sets the level from which this trace hierarchy is rendered. Set
| `level` to `''` to start from the root node in the hierarchy.
| Must be an "id" if `ids` is filled in, otherwise plotly
| attempts to find a matching item in `labels`.
|
| The 'level' property accepts values of any type
|
| Returns
| -------
| Any
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| autocolorscale
| Determines whether the colorscale is a default
| palette (`autocolorscale: true`) or the palette
| determined by `marker.colorscale`. Has an
| effect only if colors is set to a numerical
| array. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette
| will be chosen according to whether numbers in
| the `color` array are all positive, all
| negative or mixed.
| cauto
| Determines whether or not the color domain is
| computed with respect to the input data (here
| colors) or the bounds set in `marker.cmin` and
| `marker.cmax` Has an effect only if colors is
| set to a numerical array. Defaults to `false`
| when `marker.cmin` and `marker.cmax` are set by
| the user.
| cmax
| Sets the upper bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmin` must be set as
| well.
| cmid
| Sets the mid-point of the color domain by
| scaling `marker.cmin` and/or `marker.cmax` to
| be equidistant to this point. Has an effect
| only if colors is set to a numerical array.
| Value should have the same units as colors. Has
| no effect when `marker.cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Has
| an effect only if colors is set to a numerical
| array. Value should have the same units as
| colors and if set, `marker.cmax` must be set as
| well.
| coloraxis
| Sets a reference to a shared color axis.
| References to these shared color axes are
| "coloraxis", "coloraxis2", "coloraxis3", etc.
| Settings for these shared color axes are set in
| the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple
| color scales can be linked to the same color
| axis.
| colorbar
| :class:`plotly.graph_objects.treemap.marker.Col
| orBar` instance or dict with compatible
| properties
| colors
| Sets the color of each sector of this trace. If
| not specified, the default trace color set is
| used to pick the sector colors.
| colorscale
| Sets the colorscale. Has an effect only if
| colors is set to a numerical array. The
| colorscale must be an array containing arrays
| mapping a normalized value to an rgb, rgba,
| hex, hsl, hsv, or named color string. At
| minimum, a mapping for the lowest (0) and
| highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
| To control the bounds of the colorscale in
| color space, use `marker.cmin` and
| `marker.cmax`. Alternatively, `colorscale` may
| be a palette name string of the following list:
| Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
| Bu,Reds,Viridis,YlGnBu,YlOrRd.
| colorssrc
| Sets the source reference on Chart Studio Cloud
| for `colors`.
| cornerradius
| Sets the maximum rounding of corners (in px).
| depthfade
| Determines if the sector colors are faded
| towards the background from the leaves up to
| the headers. This option is unavailable when a
| `colorscale` is present, defaults to false when
| `marker.colors` is set, but otherwise defaults
| to true. When set to "reversed", the fading
| direction is inverted, that is the top elements
| within hierarchy are drawn with fully saturated
| colors while the leaves are faded towards the
| background color.
| line
| :class:`plotly.graph_objects.treemap.marker.Lin
| e` instance or dict with compatible properties
| pad
| :class:`plotly.graph_objects.treemap.marker.Pad
| ` instance or dict with compatible properties
| pattern
| Sets the pattern within the marker.
| reversescale
| Reverses the color mapping if true. Has an
| effect only if colors is set to a numerical
| array. If true, `marker.cmin` will correspond
| to the last color in the array and
| `marker.cmax` will correspond to the first
| color.
| showscale
| Determines whether or not a colorbar is
| displayed for this trace. Has an effect only if
| colors is set to a numerical array.
|
| Returns
| -------
| plotly.graph_objs.treemap.Marker
|
| maxdepth
| Sets the number of rendered sectors from any given `level`. Set
| `maxdepth` to "-1" to render all the levels in the hierarchy.
|
| The 'maxdepth' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| outsidetextfont
| Sets the font used for `textinfo` lying outside the sector.
| This option refers to the root of the hierarchy presented on
| top left corner of a treemap graph. Please note that if a
| hierarchy has multiple root nodes, this option won't have any
| effect and `insidetextfont` would be used.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Outsidetextfont
|
| parents
| Sets the parent sectors for each of the sectors. Empty string
| items '' are understood to reference the root node in the
| hierarchy. If `ids` is filled, `parents` items are understood
| to be "ids" themselves. When `ids` is not set, plotly attempts
| to find matching items in `labels`, but beware they must be
| unique.
|
| The 'parents' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| parentssrc
| Sets the source reference on Chart Studio Cloud for `parents`.
|
| The 'parentssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| pathbar
| The 'pathbar' property is an instance of Pathbar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Pathbar`
| - A dict of string/value properties that will be passed
| to the Pathbar constructor
|
| Supported dict properties:
|
| edgeshape
| Determines which shape is used for edges
| between `barpath` labels.
| side
| Determines on which side of the the treemap the
| `pathbar` should be presented.
| textfont
| Sets the font used inside `pathbar`.
| thickness
| Sets the thickness of `pathbar` (in px). If not
| specified the `pathbar.textfont.size` is used
| with 3 pixles extra padding on each side.
| visible
| Determines if the path bar is drawn i.e.
| outside the trace `domain` and with one pixel
| gap.
|
| Returns
| -------
| plotly.graph_objs.treemap.Pathbar
|
| root
| The 'root' property is an instance of Root
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Root`
| - A dict of string/value properties that will be passed
| to the Root constructor
|
| Supported dict properties:
|
| color
| sets the color of the root node for a
| sunburst/treemap/icicle trace. this has no
| effect when a colorscale is used to set the
| markers.
|
| Returns
| -------
| plotly.graph_objs.treemap.Root
|
| sort
| Determines whether or not the sectors are reordered from
| largest to smallest.
|
| The 'sort' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.treemap.Stream
|
| text
| Sets text elements associated with each sector. If trace
| `textinfo` contains a "text" flag, these elements will be seen
| on the chart. If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in the
| hover labels.
|
| The 'text' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| textfont
| Sets the font used for `textinfo`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.treemap.Textfont
|
| textinfo
| Determines which trace information appear on the graph.
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Sets the positions of the `text` elements.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['top left', 'top center', 'top right', 'middle left',
| 'middle center', 'middle right', 'bottom left', 'bottom
| center', 'bottom right']
|
| Returns
| -------
| Any
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables
| `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
| `percentParent`, `label` and `value`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| tiling
| The 'tiling' property is an instance of Tiling
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.treemap.Tiling`
| - A dict of string/value properties that will be passed
| to the Tiling constructor
|
| Supported dict properties:
|
| flip
| Determines if the positions obtained from
| solver are flipped on each axis.
| packing
| Determines d3 treemap solver. For more info
| please refer to
| https://github.com/d3/d3-hierarchy#treemap-
| tiling
| pad
| Sets the inner padding (in px).
| squarifyratio
| When using "squarify" `packing` algorithm,
| according to https://github.com/d3/d3-
| hierarchy/blob/v3.1.1/README.md#squarify_ratio
| this option specifies the desired aspect ratio
| of the generated rectangles. The ratio must be
| specified as a number greater than or equal to
| one. Note that the orientation of the generated
| rectangles (tall or wide) is not implied by the
| ratio; for example, a ratio of two will attempt
| to produce a mixture of rectangles whose
| width:height ratio is either 2:1 or 1:2. When
| using "squarify", unlike d3 which uses the
| Golden Ratio i.e. 1.618034, Plotly applies 1 to
| increase squares in treemap layouts.
|
| Returns
| -------
| plotly.graph_objs.treemap.Tiling
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| values
| Sets the values associated with each of the sectors. Use with
| `branchvalues` to determine how the values are summed.
|
| The 'values' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuessrc
| Sets the source reference on Chart Studio Cloud for `values`.
|
| The 'valuessrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Violin(plotly.basedatatypes.BaseTraceType)
| Violin(arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Violin
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, bandwidth=None, box=None, customdata=None, customdatasrc=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, jitter=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, marker=None, meanline=None, meta=None, metasrc=None, name=None, offsetgroup=None, opacity=None, orientation=None, pointpos=None, points=None, quartilemethod=None, scalegroup=None, scalemode=None, selected=None, selectedpoints=None, showlegend=None, side=None, span=None, spanmode=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, width=None, x=None, x0=None, xaxis=None, xhoverformat=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Violin object
|
| In vertical (horizontal) violin plots, statistics are computed
| using `y` (`x`) values. By supplying an `x` (`y`) array, one
| violin per distinct x (y) value is drawn If no `x` (`y`) list
| is provided, a single violin is drawn. That violin position is
| then positioned with with `name` or with `x0` (`y0`) if
| provided.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Violin`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| bandwidth
| Sets the bandwidth used to compute the kernel density
| estimate. By default, the bandwidth is determined by
| Silverman's rule of thumb.
| box
| :class:`plotly.graph_objects.violin.Box` instance or
| dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| fillcolor
| Sets the fill color. Defaults to a half-transparent
| variant of the line color, marker color, or marker line
| color, whichever is available.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.violin.Hoverlabel`
| instance or dict with compatible properties
| hoveron
| Do the hover effects highlight individual violins or
| sample points or the kernel density estimate or any
| combination of them?
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| jitter
| Sets the amount of jitter in the sample points drawn.
| If 0, the sample points align along the distribution
| axis. If 1, the sample points are drawn in a random
| jitter of width equal to the width of the violins.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.violin.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| line
| :class:`plotly.graph_objects.violin.Line` instance or
| dict with compatible properties
| marker
| :class:`plotly.graph_objects.violin.Marker` instance or
| dict with compatible properties
| meanline
| :class:`plotly.graph_objects.violin.Meanline` instance
| or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover. For violin traces, the name
| will also be used for the position coordinate, if `x`
| and `x0` (`y` and `y0` if horizontal) are missing and
| the position axis is categorical. Note that the trace
| name is also used as a default value for attribute
| `scalegroup` (please see its description for details).
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the violin(s). If "v" ("h"),
| the distribution is visualized along the vertical
| (horizontal).
| pointpos
| Sets the position of the sample points in relation to
| the violins. If 0, the sample points are places over
| the center of the violins. Positive (negative) values
| correspond to positions to the right (left) for
| vertical violins and above (below) for horizontal
| violins.
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier
| points are shown and points either less than 4*Q1-3*Q3
| or greater than 4*Q3-3*Q1 are highlighted (see
| `outliercolor`) If "all", all sample points are shown
| If False, only the violins are shown with no sample
| points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is
| set, otherwise defaults to "outliers".
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile
| for Q1 and 75th percentile for Q3 as computed using
| method #10 (listed on
| http://jse.amstat.org/v14n3/langford.html). The
| "exclusive" method uses the median to divide the
| ordered dataset into two halves if the sample is odd,
| it does not include the median in either half - Q1 is
| then the median of the lower half and Q3 the median of
| the upper half. The "inclusive" method also uses the
| median to divide the ordered dataset into two halves
| but if the sample is odd, it includes the median in
| both halves - Q1 is then the median of the lower half
| and Q3 the median of the upper half.
| scalegroup
| If there are multiple violins that should be sized
| according to to some metric (see `scalemode`), link
| them by providing a non-empty group id here shared by
| every trace in the same group. If a violin's `width` is
| undefined, `scalegroup` will default to the trace's
| name. In this case, violins with the same names will be
| linked together
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same
| (max) width "count" means the violins are scaled by the
| number of sample points making up each violin.
| selected
| :class:`plotly.graph_objects.violin.Selected` instance
| or dict with compatible properties
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| side
| Determines on which side of the position value the
| density function making up one half of a violin is
| plotted. Useful when comparing two violin traces under
| "overlay" mode, where one trace has `side` set to
| "positive" and the other to "negative".
| span
| Sets the span in data space for which the density
| function will be computed. Has an effect only when
| `spanmode` is set to "manual".
| spanmode
| Sets the method by which the span in data space where
| the density function will be computed. "soft" means the
| span goes from the sample's minimum value minus two
| bandwidths to the sample's maximum value plus two
| bandwidths. "hard" means the span goes from the
| sample's minimum to its maximum value. For custom span
| settings, use mode "manual" and fill in the `span`
| attribute.
| stream
| :class:`plotly.graph_objects.violin.Stream` instance or
| dict with compatible properties
| text
| Sets the text elements associated with each sample
| value. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| unselected
| :class:`plotly.graph_objects.violin.Unselected`
| instance or dict with compatible properties
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the width of the violin in data coordinates. If 0
| (default value) the width is automatically selected
| based on the positions of other violin traces in the
| same subplot.
| x
| Sets the x sample data or coordinates. See overview for
| more info.
| x0
| Sets the x coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y sample data or coordinates. See overview for
| more info.
| y0
| Sets the y coordinate for single-box traces or the
| starting coordinate for multi-box traces set using
| q1/median/q3. See overview for more info.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Violin
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| bandwidth
| Sets the bandwidth used to compute the kernel density estimate.
| By default, the bandwidth is determined by Silverman's rule of
| thumb.
|
| The 'bandwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| box
| The 'box' property is an instance of Box
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Box`
| - A dict of string/value properties that will be passed
| to the Box constructor
|
| Supported dict properties:
|
| fillcolor
| Sets the inner box plot fill color.
| line
| :class:`plotly.graph_objects.violin.box.Line`
| instance or dict with compatible properties
| visible
| Determines if an miniature box plot is drawn
| inside the violins.
| width
| Sets the width of the inner box plots relative
| to the violins' width. For example, with 1, the
| inner box plots are as wide as the violins.
|
| Returns
| -------
| plotly.graph_objs.violin.Box
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| fillcolor
| Sets the fill color. Defaults to a half-transparent variant of
| the line color, marker color, or marker line color, whichever
| is available.
|
| The 'fillcolor' property is a color and may be specified as:
| - A hex string (e.g. '#ff0000')
| - An rgb/rgba string (e.g. 'rgb(255,0,0)')
| - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
| - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
| - A named CSS color:
| aliceblue, antiquewhite, aqua, aquamarine, azure,
| beige, bisque, black, blanchedalmond, blue,
| blueviolet, brown, burlywood, cadetblue,
| chartreuse, chocolate, coral, cornflowerblue,
| cornsilk, crimson, cyan, darkblue, darkcyan,
| darkgoldenrod, darkgray, darkgrey, darkgreen,
| darkkhaki, darkmagenta, darkolivegreen, darkorange,
| darkorchid, darkred, darksalmon, darkseagreen,
| darkslateblue, darkslategray, darkslategrey,
| darkturquoise, darkviolet, deeppink, deepskyblue,
| dimgray, dimgrey, dodgerblue, firebrick,
| floralwhite, forestgreen, fuchsia, gainsboro,
| ghostwhite, gold, goldenrod, gray, grey, green,
| greenyellow, honeydew, hotpink, indianred, indigo,
| ivory, khaki, lavender, lavenderblush, lawngreen,
| lemonchiffon, lightblue, lightcoral, lightcyan,
| lightgoldenrodyellow, lightgray, lightgrey,
| lightgreen, lightpink, lightsalmon, lightseagreen,
| lightskyblue, lightslategray, lightslategrey,
| lightsteelblue, lightyellow, lime, limegreen,
| linen, magenta, maroon, mediumaquamarine,
| mediumblue, mediumorchid, mediumpurple,
| mediumseagreen, mediumslateblue, mediumspringgreen,
| mediumturquoise, mediumvioletred, midnightblue,
| mintcream, mistyrose, moccasin, navajowhite, navy,
| oldlace, olive, olivedrab, orange, orangered,
| orchid, palegoldenrod, palegreen, paleturquoise,
| palevioletred, papayawhip, peachpuff, peru, pink,
| plum, powderblue, purple, red, rosybrown,
| royalblue, rebeccapurple, saddlebrown, salmon,
| sandybrown, seagreen, seashell, sienna, silver,
| skyblue, slateblue, slategray, slategrey, snow,
| springgreen, steelblue, tan, teal, thistle, tomato,
| turquoise, violet, wheat, white, whitesmoke,
| yellow, yellowgreen
|
| Returns
| -------
| str
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.violin.Hoverlabel
|
| hoveron
| Do the hover effects highlight individual violins or sample
| points or the kernel density estimate or any combination of
| them?
|
| The 'hoveron' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['violins', 'points', 'kde'] joined with '+' characters
| (e.g. 'violins+points')
| OR exactly one of ['all'] (e.g. 'all')
|
| Returns
| -------
| Any
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| jitter
| Sets the amount of jitter in the sample points drawn. If 0, the
| sample points align along the distribution axis. If 1, the
| sample points are drawn in a random jitter of width equal to
| the width of the violins.
|
| The 'jitter' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.violin.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| line
| The 'line' property is an instance of Line
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Line`
| - A dict of string/value properties that will be passed
| to the Line constructor
|
| Supported dict properties:
|
| color
| Sets the color of line bounding the violin(s).
| width
| Sets the width (in px) of line bounding the
| violin(s).
|
| Returns
| -------
| plotly.graph_objs.violin.Line
|
| marker
| The 'marker' property is an instance of Marker
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Marker`
| - A dict of string/value properties that will be passed
| to the Marker constructor
|
| Supported dict properties:
|
| angle
| Sets the marker angle in respect to `angleref`.
| color
| Sets the marker color. It accepts either a
| specific color or an array of numbers that are
| mapped to the colorscale relative to the max
| and min values of the array or relative to
| `marker.cmin` and `marker.cmax` if set.
| line
| :class:`plotly.graph_objects.violin.marker.Line
| ` instance or dict with compatible properties
| opacity
| Sets the marker opacity.
| outliercolor
| Sets the color of the outlier sample points.
| size
| Sets the marker size (in px).
| symbol
| Sets the marker symbol type. Adding 100 is
| equivalent to appending "-open" to a symbol
| name. Adding 200 is equivalent to appending
| "-dot" to a symbol name. Adding 300 is
| equivalent to appending "-open-dot" or "dot-
| open" to a symbol name.
|
| Returns
| -------
| plotly.graph_objs.violin.Marker
|
| meanline
| The 'meanline' property is an instance of Meanline
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Meanline`
| - A dict of string/value properties that will be passed
| to the Meanline constructor
|
| Supported dict properties:
|
| color
| Sets the mean line color.
| visible
| Determines if a line corresponding to the
| sample's mean is shown inside the violins. If
| `box.visible` is turned on, the mean line is
| drawn inside the inner box. Otherwise, the mean
| line is drawn from one side of the violin to
| other.
| width
| Sets the mean line width.
|
| Returns
| -------
| plotly.graph_objs.violin.Meanline
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover. For violin traces, the name will also be used for
| the position coordinate, if `x` and `x0` (`y` and `y0` if
| horizontal) are missing and the position axis is categorical.
| Note that the trace name is also used as a default value for
| attribute `scalegroup` (please see its description for
| details).
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the violin(s). If "v" ("h"), the
| distribution is visualized along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| pointpos
| Sets the position of the sample points in relation to the
| violins. If 0, the sample points are places over the center of
| the violins. Positive (negative) values correspond to positions
| to the right (left) for vertical violins and above (below) for
| horizontal violins.
|
| The 'pointpos' property is a number and may be specified as:
| - An int or float in the interval [-2, 2]
|
| Returns
| -------
| int|float
|
| points
| If "outliers", only the sample points lying outside the
| whiskers are shown If "suspectedoutliers", the outlier points
| are shown and points either less than 4*Q1-3*Q3 or greater than
| 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all
| sample points are shown If False, only the violins are shown
| with no sample points. Defaults to "suspectedoutliers" when
| `marker.outliercolor` or `marker.line.outliercolor` is set,
| otherwise defaults to "outliers".
|
| The 'points' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['all', 'outliers', 'suspectedoutliers', False]
|
| Returns
| -------
| Any
|
| quartilemethod
| Sets the method used to compute the sample's Q1 and Q3
| quartiles. The "linear" method uses the 25th percentile for Q1
| and 75th percentile for Q3 as computed using method #10 (listed
| on http://jse.amstat.org/v14n3/langford.html). The "exclusive"
| method uses the median to divide the ordered dataset into two
| halves if the sample is odd, it does not include the median in
| either half - Q1 is then the median of the lower half and Q3
| the median of the upper half. The "inclusive" method also uses
| the median to divide the ordered dataset into two halves but if
| the sample is odd, it includes the median in both halves - Q1
| is then the median of the lower half and Q3 the median of the
| upper half.
|
| The 'quartilemethod' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['linear', 'exclusive', 'inclusive']
|
| Returns
| -------
| Any
|
| scalegroup
| If there are multiple violins that should be sized according to
| to some metric (see `scalemode`), link them by providing a non-
| empty group id here shared by every trace in the same group. If
| a violin's `width` is undefined, `scalegroup` will default to
| the trace's name. In this case, violins with the same names
| will be linked together
|
| The 'scalegroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| scalemode
| Sets the metric by which the width of each violin is
| determined. "width" means each violin has the same (max) width
| "count" means the violins are scaled by the number of sample
| points making up each violin.
|
| The 'scalemode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['width', 'count']
|
| Returns
| -------
| Any
|
| selected
| The 'selected' property is an instance of Selected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Selected`
| - A dict of string/value properties that will be passed
| to the Selected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.violin.selected.Ma
| rker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.violin.Selected
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| side
| Determines on which side of the position value the density
| function making up one half of a violin is plotted. Useful when
| comparing two violin traces under "overlay" mode, where one
| trace has `side` set to "positive" and the other to "negative".
|
| The 'side' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['both', 'positive', 'negative']
|
| Returns
| -------
| Any
|
| span
| Sets the span in data space for which the density function will
| be computed. Has an effect only when `spanmode` is set to
| "manual".
|
| The 'span' property is an info array that may be specified as:
|
| * a list or tuple of 2 elements where:
| (0) The 'span[0]' property accepts values of any type
| (1) The 'span[1]' property accepts values of any type
|
| Returns
| -------
| list
|
| spanmode
| Sets the method by which the span in data space where the
| density function will be computed. "soft" means the span goes
| from the sample's minimum value minus two bandwidths to the
| sample's maximum value plus two bandwidths. "hard" means the
| span goes from the sample's minimum to its maximum value. For
| custom span settings, use mode "manual" and fill in the `span`
| attribute.
|
| The 'spanmode' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['soft', 'hard', 'manual']
|
| Returns
| -------
| Any
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.violin.Stream
|
| text
| Sets the text elements associated with each sample value. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| unselected
| The 'unselected' property is an instance of Unselected
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.violin.Unselected`
| - A dict of string/value properties that will be passed
| to the Unselected constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.violin.unselected.
| Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.violin.Unselected
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the width of the violin in data coordinates. If 0 (default
| value) the width is automatically selected based on the
| positions of other violin traces in the same subplot.
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| x
| Sets the x sample data or coordinates. See overview for more
| info.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Sets the x coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y sample data or coordinates. See overview for more
| info.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Sets the y coordinate for single-box traces or the starting
| coordinate for multi-box traces set using q1/median/q3. See
| overview for more info.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Volume(plotly.basedatatypes.BaseTraceType)
| Volume(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
|
| Method resolution order:
| Volume
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)
| Construct a new Volume object
|
| Draws volume trace between iso-min and iso-max values with
| coordinates given by four 1-dimensional arrays containing the
| `value`, `x`, `y` and `z` of every vertex of a uniform or non-
| uniform 3-D grid. Horizontal or vertical slices, caps as well
| as spaceframe between iso-min and iso-max values could also be
| drawn using this trace.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Volume`
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be
| chosen according to whether numbers in the `color`
| array are all positive, all negative or mixed.
| caps
| :class:`plotly.graph_objects.volume.Caps` instance or
| dict with compatible properties
| cauto
| Determines whether or not the color domain is computed
| with respect to the input data (here `value`) or the
| bounds set in `cmin` and `cmax` Defaults to `false`
| when `cmin` and `cmax` are set by the user.
| cmax
| Sets the upper bound of the color domain. Value should
| have the same units as `value` and if set, `cmin` must
| be set as well.
| cmid
| Sets the mid-point of the color domain by scaling
| `cmin` and/or `cmax` to be equidistant to this point.
| Value should have the same units as `value`. Has no
| effect when `cauto` is `false`.
| cmin
| Sets the lower bound of the color domain. Value should
| have the same units as `value` and if set, `cmax` must
| be set as well.
| coloraxis
| Sets a reference to a shared color axis. References to
| these shared color axes are "coloraxis", "coloraxis2",
| "coloraxis3", etc. Settings for these shared color axes
| are set in the layout, under `layout.coloraxis`,
| `layout.coloraxis2`, etc. Note that multiple color
| scales can be linked to the same color axis.
| colorbar
| :class:`plotly.graph_objects.volume.ColorBar` instance
| or dict with compatible properties
| colorscale
| Sets the colorscale. The colorscale must be an array
| containing arrays mapping a normalized value to an rgb,
| rgba, hex, hsl, hsv, or named color string. At minimum,
| a mapping for the lowest (0) and highest (1) values are
| required. For example, `[[0, 'rgb(0,0,255)'], [1,
| 'rgb(255,0,0)']]`. To control the bounds of the
| colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name
| string of the following list: Blackbody,Bluered,Blues,C
| ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
| and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
| contour
| :class:`plotly.graph_objects.volume.Contour` instance
| or dict with compatible properties
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| flatshading
| Determines whether or not normal smoothing is applied
| to the meshes, creating meshes with an angular, low-
| poly look via flat reflections.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.volume.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Anything contained in tag `<extra>` is
| displayed in the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Same as `text`.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| isomax
| Sets the maximum boundary for iso-surface plot.
| isomin
| Sets the minimum boundary for iso-surface plot.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.volume.Legendgrouptitle`
| instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| lighting
| :class:`plotly.graph_objects.volume.Lighting` instance
| or dict with compatible properties
| lightposition
| :class:`plotly.graph_objects.volume.Lightposition`
| instance or dict with compatible properties
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| opacity
| Sets the opacity of the surface. Please note that in
| the case of using high `opacity` values for example a
| value greater than or equal to 0.5 on two surfaces (and
| 0.25 with four surfaces), an overlay of multiple
| transparent surfaces may not perfectly be sorted in
| depth by the webgl API. This behavior may be improved
| in the near future and is subject to change.
| opacityscale
| Sets the opacityscale. The opacityscale must be an
| array containing arrays mapping a normalized value to
| an opacity value. At minimum, a mapping for the lowest
| (0) and highest (1) values are required. For example,
| `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower
| values would have higher opacity values and those in
| the middle would be more transparent Alternatively,
| `opacityscale` may be a palette name string of the
| following list: 'min', 'max', 'extremes' and 'uniform'.
| The default is 'uniform'.
| reversescale
| Reverses the color mapping if true. If true, `cmin`
| will correspond to the last color in the array and
| `cmax` will correspond to the first color.
| scene
| Sets a reference between this trace's 3D coordinate
| system and a 3D scene. If "scene" (the default value),
| the (x,y,z) coordinates refer to `layout.scene`. If
| "scene2", the (x,y,z) coordinates refer to
| `layout.scene2`, and so on.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| showscale
| Determines whether or not a colorbar is displayed for
| this trace.
| slices
| :class:`plotly.graph_objects.volume.Slices` instance or
| dict with compatible properties
| spaceframe
| :class:`plotly.graph_objects.volume.Spaceframe`
| instance or dict with compatible properties
| stream
| :class:`plotly.graph_objects.volume.Stream` instance or
| dict with compatible properties
| surface
| :class:`plotly.graph_objects.volume.Surface` instance
| or dict with compatible properties
| text
| Sets the text elements associated with the vertices. If
| trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| value
| Sets the 4th dimension (value) of the vertices.
| valuehoverformat
| Sets the hover text formatting rulefor `value` using
| d3 formatting mini-languages which are very similar to
| those in Python. For numbers, see: https://github.com/d
| 3/d3-format/tree/v1.4.5#d3-format.By default the values
| are formatted using generic number format.
| valuesrc
| Sets the source reference on Chart Studio Cloud for
| `value`.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| x
| Sets the X coordinates of the vertices on X axis.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the Y coordinates of the vertices on Y axis.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| z
| Sets the Z coordinates of the vertices on Z axis.
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `zaxis.hoverformat`.
| zsrc
| Sets the source reference on Chart Studio Cloud for
| `z`.
|
| Returns
| -------
| Volume
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| autocolorscale
| Determines whether the colorscale is a default palette
| (`autocolorscale: true`) or the palette determined by
| `colorscale`. In case `colorscale` is unspecified or
| `autocolorscale` is true, the default palette will be chosen
| according to whether numbers in the `color` array are all
| positive, all negative or mixed.
|
| The 'autocolorscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| caps
| The 'caps' property is an instance of Caps
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Caps`
| - A dict of string/value properties that will be passed
| to the Caps constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.volume.caps.X`
| instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.volume.caps.Y`
| instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.volume.caps.Z`
| instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.volume.Caps
|
| cauto
| Determines whether or not the color domain is computed with
| respect to the input data (here `value`) or the bounds set in
| `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax`
| are set by the user.
|
| The 'cauto' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| cmax
| Sets the upper bound of the color domain. Value should have the
| same units as `value` and if set, `cmin` must be set as well.
|
| The 'cmax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmid
| Sets the mid-point of the color domain by scaling `cmin` and/or
| `cmax` to be equidistant to this point. Value should have the
| same units as `value`. Has no effect when `cauto` is `false`.
|
| The 'cmid' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cmin
| Sets the lower bound of the color domain. Value should have the
| same units as `value` and if set, `cmax` must be set as well.
|
| The 'cmin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| coloraxis
| Sets a reference to a shared color axis. References to these
| shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
| etc. Settings for these shared color axes are set in the
| layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
| Note that multiple color scales can be linked to the same color
| axis.
|
| The 'coloraxis' property is an identifier of a particular
| subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
| optionally followed by an integer >= 1
| (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
| Returns
| -------
| str
|
| colorbar
| The 'colorbar' property is an instance of ColorBar
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.ColorBar`
| - A dict of string/value properties that will be passed
| to the ColorBar constructor
|
| Supported dict properties:
|
| bgcolor
| Sets the color of padded area.
| bordercolor
| Sets the axis line color.
| borderwidth
| Sets the width (in px) or the border enclosing
| this color bar.
| dtick
| Sets the step in-between ticks on this axis.
| Use with `tick0`. Must be a positive number, or
| special strings available to "log" and "date"
| axes. If the axis `type` is "log", then ticks
| are set every 10^(n*dtick) where n is the tick
| number. For example, to set a tick mark at 1,
| 10, 100, 1000, ... set dtick to 1. To set tick
| marks at 1, 100, 10000, ... set dtick to 2. To
| set tick marks at 1, 5, 25, 125, 625, 3125, ...
| set dtick to log_10(5), or 0.69897000433. "log"
| has several special values; "L<f>", where `f`
| is a positive number, gives ticks linearly
| spaced in value (but not position). For example
| `tick0` = 0.1, `dtick` = "L0.5" will put ticks
| at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
| plus small digits between, use "D1" (all
| digits) or "D2" (only 2 and 5). `tick0` is
| ignored for "D1" and "D2". If the axis `type`
| is "date", then you must convert the time to
| milliseconds. For example, to set the interval
| between ticks to one day, set `dtick` to
| 86400000.0. "date" also has special values
| "M<n>" gives ticks spaced by a number of
| months. `n` must be a positive integer. To set
| ticks on the 15th of every third month, set
| `tick0` to "2000-01-15" and `dtick` to "M3". To
| set ticks every 4 years, set `dtick` to "M48"
| exponentformat
| Determines a formatting rule for the tick
| exponents. For example, consider the number
| 1,000,000,000. If "none", it appears as
| 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
| "power", 1x10^9 (with 9 in a super script). If
| "SI", 1G. If "B", 1B.
| labelalias
| Replacement text for specific tick or hover
| labels. For example using {US: 'USA', CA:
| 'Canada'} changes US to USA and CA to Canada.
| The labels we would have shown must match the
| keys exactly, after adding any tickprefix or
| ticksuffix. For negative numbers the minus sign
| symbol used (U+2212) is wider than the regular
| ascii dash. That means you need to use −1
| instead of -1. labelalias can be used with any
| axis type, and both keys (if needed) and values
| (if desired) can include html-like tags or
| MathJax.
| len
| Sets the length of the color bar This measure
| excludes the padding of both ends. That is, the
| color bar length is this length minus the
| padding on both ends.
| lenmode
| Determines whether this color bar's length
| (i.e. the measure in the color variation
| direction) is set in units of plot "fraction"
| or in *pixels. Use `len` to set the value.
| minexponent
| Hide SI prefix for 10^n if |n| is below this
| number. This only has an effect when
| `tickformat` is "SI" or "B".
| nticks
| Specifies the maximum number of ticks for the
| particular axis. The actual number of ticks
| will be chosen automatically to be less than or
| equal to `nticks`. Has an effect only if
| `tickmode` is set to "auto".
| orientation
| Sets the orientation of the colorbar.
| outlinecolor
| Sets the axis line color.
| outlinewidth
| Sets the width (in px) of the axis line.
| separatethousands
| If "true", even 4-digit integers are separated
| showexponent
| If "all", all exponents are shown besides their
| significands. If "first", only the exponent of
| the first tick is shown. If "last", only the
| exponent of the last tick is shown. If "none",
| no exponents appear.
| showticklabels
| Determines whether or not the tick labels are
| drawn.
| showtickprefix
| If "all", all tick labels are displayed with a
| prefix. If "first", only the first tick is
| displayed with a prefix. If "last", only the
| last tick is displayed with a suffix. If
| "none", tick prefixes are hidden.
| showticksuffix
| Same as `showtickprefix` but for tick suffixes.
| thickness
| Sets the thickness of the color bar This
| measure excludes the size of the padding, ticks
| and labels.
| thicknessmode
| Determines whether this color bar's thickness
| (i.e. the measure in the constant color
| direction) is set in units of plot "fraction"
| or in "pixels". Use `thickness` to set the
| value.
| tick0
| Sets the placement of the first tick on this
| axis. Use with `dtick`. If the axis `type` is
| "log", then you must take the log of your
| starting tick (e.g. to set the starting tick to
| 100, set the `tick0` to 2) except when
| `dtick`=*L<f>* (see `dtick` for more info). If
| the axis `type` is "date", it should be a date
| string, like date data. If the axis `type` is
| "category", it should be a number, using the
| scale where each category is assigned a serial
| number from zero in the order it appears.
| tickangle
| Sets the angle of the tick labels with respect
| to the horizontal. For example, a `tickangle`
| of -90 draws the tick labels vertically.
| tickcolor
| Sets the tick color.
| tickfont
| Sets the color bar's tick label font
| tickformat
| Sets the tick label formatting rule using d3
| formatting mini-languages which are very
| similar to those in Python. For numbers, see: h
| ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
| format. And for dates see:
| https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two
| items to d3's date formatter: "%h" for half of
| the year as a decimal number as well as "%{n}f"
| for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with
| tickformat "%H~%M~%S.%2f" would display
| "09~15~23.46"
| tickformatstops
| A tuple of :class:`plotly.graph_objects.volume.
| colorbar.Tickformatstop` instances or dicts
| with compatible properties
| tickformatstopdefaults
| When used in a template (as layout.template.dat
| a.volume.colorbar.tickformatstopdefaults), sets
| the default property values to use for elements
| of volume.colorbar.tickformatstops
| ticklabeloverflow
| Determines how we handle tick labels that would
| overflow either the graph div or the domain of
| the axis. The default value for inside tick
| labels is *hide past domain*. In other cases
| the default is *hide past div*.
| ticklabelposition
| Determines where tick labels are drawn relative
| to the ticks. Left and right options are used
| when `orientation` is "h", top and bottom when
| `orientation` is "v".
| ticklabelstep
| Sets the spacing between tick labels as
| compared to the spacing between ticks. A value
| of 1 (default) means each tick gets a label. A
| value of 2 means shows every 2nd label. A
| larger value n means only every nth tick is
| labeled. `tick0` determines which labels are
| shown. Not implemented for axes with `type`
| "log" or "multicategory", or when `tickmode` is
| "array".
| ticklen
| Sets the tick length (in px).
| tickmode
| Sets the tick mode for this axis. If "auto",
| the number of ticks is set via `nticks`. If
| "linear", the placement of the ticks is
| determined by a starting position `tick0` and a
| tick step `dtick` ("linear" is the default
| value if `tick0` and `dtick` are provided). If
| "array", the placement of the ticks is set via
| `tickvals` and the tick text is `ticktext`.
| ("array" is the default value if `tickvals` is
| provided).
| tickprefix
| Sets a tick label prefix.
| ticks
| Determines whether ticks are drawn or not. If
| "", this axis' ticks are not drawn. If
| "outside" ("inside"), this axis' are drawn
| outside (inside) the axis lines.
| ticksuffix
| Sets a tick label suffix.
| ticktext
| Sets the text displayed at the ticks position
| via `tickvals`. Only has an effect if
| `tickmode` is set to "array". Used with
| `tickvals`.
| ticktextsrc
| Sets the source reference on Chart Studio Cloud
| for `ticktext`.
| tickvals
| Sets the values at which ticks on this axis
| appear. Only has an effect if `tickmode` is set
| to "array". Used with `ticktext`.
| tickvalssrc
| Sets the source reference on Chart Studio Cloud
| for `tickvals`.
| tickwidth
| Sets the tick width (in px).
| title
| :class:`plotly.graph_objects.volume.colorbar.Ti
| tle` instance or dict with compatible
| properties
| titlefont
| Deprecated: Please use
| volume.colorbar.title.font instead. Sets this
| color bar's title font. Note that the title's
| font used to be set by the now deprecated
| `titlefont` attribute.
| titleside
| Deprecated: Please use
| volume.colorbar.title.side instead. Determines
| the location of color bar's title with respect
| to the color bar. Defaults to "top" when
| `orientation` if "v" and defaults to "right"
| when `orientation` if "h". Note that the
| title's location used to be set by the now
| deprecated `titleside` attribute.
| x
| Sets the x position with respect to `xref` of
| the color bar (in plot fraction). When `xref`
| is "paper", defaults to 1.02 when `orientation`
| is "v" and 0.5 when `orientation` is "h". When
| `xref` is "container", defaults to 1 when
| `orientation` is "v" and 0.5 when `orientation`
| is "h". Must be between 0 and 1 if `xref` is
| "container" and between "-2" and 3 if `xref` is
| "paper".
| xanchor
| Sets this color bar's horizontal position
| anchor. This anchor binds the `x` position to
| the "left", "center" or "right" of the color
| bar. Defaults to "left" when `orientation` is
| "v" and "center" when `orientation` is "h".
| xpad
| Sets the amount of padding (in px) along the x
| direction.
| xref
| Sets the container `x` refers to. "container"
| spans the entire `width` of the plot. "paper"
| refers to the width of the plotting area only.
| y
| Sets the y position with respect to `yref` of
| the color bar (in plot fraction). When `yref`
| is "paper", defaults to 0.5 when `orientation`
| is "v" and 1.02 when `orientation` is "h". When
| `yref` is "container", defaults to 0.5 when
| `orientation` is "v" and 1 when `orientation`
| is "h". Must be between 0 and 1 if `yref` is
| "container" and between "-2" and 3 if `yref` is
| "paper".
| yanchor
| Sets this color bar's vertical position anchor
| This anchor binds the `y` position to the
| "top", "middle" or "bottom" of the color bar.
| Defaults to "middle" when `orientation` is "v"
| and "bottom" when `orientation` is "h".
| ypad
| Sets the amount of padding (in px) along the y
| direction.
| yref
| Sets the container `y` refers to. "container"
| spans the entire `height` of the plot. "paper"
| refers to the height of the plotting area only.
|
| Returns
| -------
| plotly.graph_objs.volume.ColorBar
|
| colorscale
| Sets the colorscale. The colorscale must be an array containing
| arrays mapping a normalized value to an rgb, rgba, hex, hsl,
| hsv, or named color string. At minimum, a mapping for the
| lowest (0) and highest (1) values are required. For example,
| `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
| bounds of the colorscale in color space, use `cmin` and `cmax`.
| Alternatively, `colorscale` may be a palette name string of the
| following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
| Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
| YlGnBu,YlOrRd.
|
| The 'colorscale' property is a colorscale and may be
| specified as:
| - A list of colors that will be spaced evenly to create the colorscale.
| Many predefined colorscale lists are included in the sequential, diverging,
| and cyclical modules in the plotly.colors package.
| - A list of 2-element lists where the first element is the
| normalized color level value (starting at 0 and ending at 1),
| and the second item is a valid color string.
| (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
| - One of the following named colorscales:
| ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
| 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
| 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
| 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
| 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
| 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
| 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
| 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
| 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
| 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
| 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
| 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
| 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
| 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
| 'ylorrd'].
| Appending '_r' to a named colorscale reverses it.
|
| Returns
| -------
| str
|
| contour
| The 'contour' property is an instance of Contour
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Contour`
| - A dict of string/value properties that will be passed
| to the Contour constructor
|
| Supported dict properties:
|
| color
| Sets the color of the contour lines.
| show
| Sets whether or not dynamic contours are shown
| on hover
| width
| Sets the width of the contour lines.
|
| Returns
| -------
| plotly.graph_objs.volume.Contour
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| flatshading
| Determines whether or not normal smoothing is applied to the
| meshes, creating meshes with an angular, low-poly look via flat
| reflections.
|
| The 'flatshading' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
| (e.g. 'x+y')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.volume.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Anything
| contained in tag `<extra>` is displayed in the secondary box,
| for example "<extra>{fullData.name}</extra>". To hide the
| secondary box completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Same as `text`.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| isomax
| Sets the maximum boundary for iso-surface plot.
|
| The 'isomax' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| isomin
| Sets the minimum boundary for iso-surface plot.
|
| The 'isomin' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.volume.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| lighting
| The 'lighting' property is an instance of Lighting
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Lighting`
| - A dict of string/value properties that will be passed
| to the Lighting constructor
|
| Supported dict properties:
|
| ambient
| Ambient light increases overall color
| visibility but can wash out the image.
| diffuse
| Represents the extent that incident rays are
| reflected in a range of angles.
| facenormalsepsilon
| Epsilon for face normals calculation avoids
| math issues arising from degenerate geometry.
| fresnel
| Represents the reflectance as a dependency of
| the viewing angle; e.g. paper is reflective
| when viewing it from the edge of the paper
| (almost 90 degrees), causing shine.
| roughness
| Alters specular reflection; the rougher the
| surface, the wider and less contrasty the
| shine.
| specular
| Represents the level that incident rays are
| reflected in a single direction, causing shine.
| vertexnormalsepsilon
| Epsilon for vertex normals calculation avoids
| math issues arising from degenerate geometry.
|
| Returns
| -------
| plotly.graph_objs.volume.Lighting
|
| lightposition
| The 'lightposition' property is an instance of Lightposition
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Lightposition`
| - A dict of string/value properties that will be passed
| to the Lightposition constructor
|
| Supported dict properties:
|
| x
| Numeric vector, representing the X coordinate
| for each vertex.
| y
| Numeric vector, representing the Y coordinate
| for each vertex.
| z
| Numeric vector, representing the Z coordinate
| for each vertex.
|
| Returns
| -------
| plotly.graph_objs.volume.Lightposition
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the surface. Please note that in the case
| of using high `opacity` values for example a value greater than
| or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
| an overlay of multiple transparent surfaces may not perfectly
| be sorted in depth by the webgl API. This behavior may be
| improved in the near future and is subject to change.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| opacityscale
| Sets the opacityscale. The opacityscale must be an array
| containing arrays mapping a normalized value to an opacity
| value. At minimum, a mapping for the lowest (0) and highest (1)
| values are required. For example, `[[0, 1], [0.5, 0.2], [1,
| 1]]` means that higher/lower values would have higher opacity
| values and those in the middle would be more transparent
| Alternatively, `opacityscale` may be a palette name string of
| the following list: 'min', 'max', 'extremes' and 'uniform'. The
| default is 'uniform'.
|
| The 'opacityscale' property accepts values of any type
|
| Returns
| -------
| Any
|
| reversescale
| Reverses the color mapping if true. If true, `cmin` will
| correspond to the last color in the array and `cmax` will
| correspond to the first color.
|
| The 'reversescale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| scene
| Sets a reference between this trace's 3D coordinate system and
| a 3D scene. If "scene" (the default value), the (x,y,z)
| coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
| coordinates refer to `layout.scene2`, and so on.
|
| The 'scene' property is an identifier of a particular
| subplot, of type 'scene', that may be specified as the string 'scene'
| optionally followed by an integer >= 1
| (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.)
|
| Returns
| -------
| str
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| showscale
| Determines whether or not a colorbar is displayed for this
| trace.
|
| The 'showscale' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| slices
| The 'slices' property is an instance of Slices
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Slices`
| - A dict of string/value properties that will be passed
| to the Slices constructor
|
| Supported dict properties:
|
| x
| :class:`plotly.graph_objects.volume.slices.X`
| instance or dict with compatible properties
| y
| :class:`plotly.graph_objects.volume.slices.Y`
| instance or dict with compatible properties
| z
| :class:`plotly.graph_objects.volume.slices.Z`
| instance or dict with compatible properties
|
| Returns
| -------
| plotly.graph_objs.volume.Slices
|
| spaceframe
| The 'spaceframe' property is an instance of Spaceframe
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Spaceframe`
| - A dict of string/value properties that will be passed
| to the Spaceframe constructor
|
| Supported dict properties:
|
| fill
| Sets the fill ratio of the `spaceframe`
| elements. The default fill value is 1 meaning
| that they are entirely shaded. Applying a
| `fill` ratio less than one would allow the
| creation of openings parallel to the edges.
| show
| Displays/hides tetrahedron shapes between
| minimum and maximum iso-values. Often useful
| when either caps or surfaces are disabled or
| filled with values less than 1.
|
| Returns
| -------
| plotly.graph_objs.volume.Spaceframe
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.volume.Stream
|
| surface
| The 'surface' property is an instance of Surface
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.volume.Surface`
| - A dict of string/value properties that will be passed
| to the Surface constructor
|
| Supported dict properties:
|
| count
| Sets the number of iso-surfaces between minimum
| and maximum iso-values. By default this value
| is 2 meaning that only minimum and maximum
| surfaces would be drawn.
| fill
| Sets the fill ratio of the iso-surface. The
| default fill value of the surface is 1 meaning
| that they are entirely shaded. On the other
| hand Applying a `fill` ratio less than one
| would allow the creation of openings parallel
| to the edges.
| pattern
| Sets the surface pattern of the iso-surface 3-D
| sections. The default pattern of the surface is
| `all` meaning that the rest of surface elements
| would be shaded. The check options (either 1 or
| 2) could be used to draw half of the squares on
| the surface. Using various combinations of
| capital `A`, `B`, `C`, `D` and `E` may also be
| used to reduce the number of triangles on the
| iso-surfaces and creating other patterns of
| interest.
| show
| Hides/displays surfaces between minimum and
| maximum iso-values.
|
| Returns
| -------
| plotly.graph_objs.volume.Surface
|
| text
| Sets the text elements associated with the vertices. If trace
| `hoverinfo` contains a "text" flag and "hovertext" is not set,
| these elements will be seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| value
| Sets the 4th dimension (value) of the vertices.
|
| The 'value' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| valuehoverformat
| Sets the hover text formatting rulefor `value` using d3
| formatting mini-languages which are very similar to those in
| Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By
| default the values are formatted using generic number format.
|
| The 'valuehoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| valuesrc
| Sets the source reference on Chart Studio Cloud for `value`.
|
| The 'valuesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| x
| Sets the X coordinates of the vertices on X axis.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the Y coordinates of the vertices on Y axis.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| z
| Sets the Z coordinates of the vertices on Z axis.
|
| The 'z' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| zhoverformat
| Sets the hover text formatting rulefor `z` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `zaxis.hoverformat`.
|
| The 'zhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| zsrc
| Sets the source reference on Chart Studio Cloud for `z`.
|
| The 'zsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class Waterfall(plotly.basedatatypes.BaseTraceType)
| Waterfall(arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
|
| Method resolution order:
| Waterfall
| plotly.basedatatypes.BaseTraceType
| plotly.basedatatypes.BaseTraceHierarchyType
| plotly.basedatatypes.BasePlotlyType
| builtins.object
|
| Methods defined here:
|
| __init__(self, arg=None, alignmentgroup=None, base=None, cliponaxis=None, connector=None, constraintext=None, customdata=None, customdatasrc=None, decreasing=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, increasing=None, insidetextanchor=None, insidetextfont=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, measure=None, measuresrc=None, meta=None, metasrc=None, name=None, offset=None, offsetgroup=None, offsetsrc=None, opacity=None, orientation=None, outsidetextfont=None, selectedpoints=None, showlegend=None, stream=None, text=None, textangle=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, totals=None, uid=None, uirevision=None, visible=None, width=None, widthsrc=None, x=None, x0=None, xaxis=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, y=None, y0=None, yaxis=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, zorder=None, **kwargs)
| Construct a new Waterfall object
|
| Draws waterfall trace which is useful graph to displays the
| contribution of various elements (either positive or negative)
| in a bar chart. The data visualized by the span of the bars is
| set in `y` if `orientation` is set to "v" (the default) and the
| labels are set in `x`. By setting `orientation` to "h", the
| roles are interchanged.
|
| Parameters
| ----------
| arg
| dict of properties compatible with this constructor or
| an instance of :class:`plotly.graph_objs.Waterfall`
| alignmentgroup
| Set several traces linked to the same position axis or
| matching axes to the same alignmentgroup. This controls
| whether bars compute their positional range dependently
| or independently.
| base
| Sets where the bar base is drawn (in position axis
| units).
| cliponaxis
| Determines whether the text nodes are clipped about the
| subplot axes. To show the text nodes above axis lines
| and tick labels, make sure to set `xaxis.layer` and
| `yaxis.layer` to *below traces*.
| connector
| :class:`plotly.graph_objects.waterfall.Connector`
| instance or dict with compatible properties
| constraintext
| Constrain the size of text inside or outside a bar to
| be no larger than the bar itself.
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note
| that, "scatter" traces also appends customdata items in
| the markers DOM elements
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
| decreasing
| :class:`plotly.graph_objects.waterfall.Decreasing`
| instance or dict with compatible properties
| dx
| Sets the x coordinate step. See `x0` for more info.
| dy
| Sets the y coordinate step. See `y0` for more info.
| hoverinfo
| Determines which trace information appear on hover. If
| `none` or `skip` are set, no information is displayed
| upon hovering. But, if `none` is set, click and hover
| events are still fired.
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
| hoverlabel
| :class:`plotly.graph_objects.waterfall.Hoverlabel`
| instance or dict with compatible properties
| hovertemplate
| Template string used for rendering the information that
| appear on hover box. Note that this will override
| `hoverinfo`. Variables are inserted using %{variable},
| for example "y: %{y}" as well as %{xother}, {%_xother},
| {%_xother_}, {%xother_}. When showing info for several
| points, "xother" will be added to those with different
| x positions from the first point. An underscore before
| or after "(x|y)other" will add a space on that side,
| only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for
| example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. The variables available in
| `hovertemplate` are the ones emitted as event data
| described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-
| data. Additionally, every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta` and `final`. Anything
| contained in tag `<extra>` is displayed in the
| secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary
| box completely, use an empty tag `<extra></extra>`.
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
| hovertext
| Sets hover text elements associated with each (x,y)
| pair. If a single string, the same string appears over
| all the data points. If an array of string, the items
| are mapped in order to the this trace's (x,y)
| coordinates. To be seen, trace `hoverinfo` must contain
| a "text" flag.
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
| ids
| Assigns id labels to each datum. These ids for object
| constancy of data points during animation. Should be an
| array of strings, not numbers or any other type.
| idssrc
| Sets the source reference on Chart Studio Cloud for
| `ids`.
| increasing
| :class:`plotly.graph_objects.waterfall.Increasing`
| instance or dict with compatible properties
| insidetextanchor
| Determines if texts are kept at center or start/end
| points in `textposition` "inside" mode.
| insidetextfont
| Sets the font used for `text` lying inside the bar.
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2",
| "legend3", etc. Settings for these legends are set in
| the layout, under `layout.legend`, `layout.legend2`,
| etc.
| legendgroup
| Sets the legend group for this trace. Traces and shapes
| part of the same legend group hide/show at the same
| time when toggling legend items.
| legendgrouptitle
| :class:`plotly.graph_objects.waterfall.Legendgrouptitle
| ` instance or dict with compatible properties
| legendrank
| Sets the legend rank for this trace. Items and groups
| with smaller ranks are presented on top/left side while
| with "reversed" `legend.traceorder` they are on
| bottom/right side. The default legendrank is 1000, so
| that you can use ranks less than 1000 to place certain
| items before all unranked items, and ranks greater than
| 1000 to go after all unranked items. When having
| unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and
| layout.
| legendwidth
| Sets the width (in px or fraction) of the legend for
| this trace.
| measure
| An array containing types of values. By default the
| values are considered as 'relative'. However; it is
| possible to use 'total' to compute the sums. Also
| 'absolute' could be applied to reset the computed total
| or to declare an initial value where needed.
| measuresrc
| Sets the source reference on Chart Studio Cloud for
| `measure`.
| meta
| Assigns extra meta information associated with this
| trace that can be used in various text attributes.
| Attributes such as trace `name`, graph, axis and
| colorbar `title.text`, annotation `text`
| `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta`
| values in an attribute in the same trace, simply use
| `%{meta[i]}` where `i` is the index or key of the
| `meta` item in question. To access trace `meta` in
| layout attributes, use `%{data[n[.meta[i]}` where `i`
| is the index or key of the `meta` and `n` is the trace
| index.
| metasrc
| Sets the source reference on Chart Studio Cloud for
| `meta`.
| name
| Sets the trace name. The trace name appears as the
| legend item and on hover.
| offset
| Shifts the position where the bar is drawn (in position
| axis units). In "group" barmode, traces that set
| "offset" will be excluded and drawn in "overlay" mode
| instead.
| offsetgroup
| Set several traces linked to the same position axis or
| matching axes to the same offsetgroup where bars of the
| same position coordinate will line up.
| offsetsrc
| Sets the source reference on Chart Studio Cloud for
| `offset`.
| opacity
| Sets the opacity of the trace.
| orientation
| Sets the orientation of the bars. With "v" ("h"), the
| value of the each bar spans along the vertical
| (horizontal).
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
| selectedpoints
| Array containing integer indices of selected points.
| Has an effect only for traces that support selections.
| Note that an empty array means an empty selection where
| the `unselected` are turned on for all points, whereas,
| any other non-array values means no selection all where
| the `selected` and `unselected` styles have no effect.
| showlegend
| Determines whether or not an item corresponding to this
| trace is shown in the legend.
| stream
| :class:`plotly.graph_objects.waterfall.Stream` instance
| or dict with compatible properties
| text
| Sets text elements associated with each (x,y) pair. If
| a single string, the same string appears over all the
| data points. If an array of string, the items are
| mapped in order to the this trace's (x,y) coordinates.
| If trace `hoverinfo` contains a "text" flag and
| "hovertext" is not set, these elements will be seen in
| the hover labels.
| textangle
| Sets the angle of the tick labels with respect to the
| bar. For example, a `tickangle` of -90 draws the tick
| labels vertically. With "auto" the texts may
| automatically be rotated to fit with the maximum size
| in bars.
| textfont
| Sets the font used for `text`.
| textinfo
| Determines which trace information appear on the graph.
| In the case of having multiple waterfalls, totals are
| computed separately (per trace).
| textposition
| Specifies the location of the `text`. "inside"
| positions `text` inside, next to the bar end (rotated
| and scaled if needed). "outside" positions `text`
| outside, next to the bar end (scaled if needed), unless
| there is another bar stacked on this one, then the text
| gets pushed inside. "auto" tries to position `text`
| inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If
| "none", no text appears.
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
| textsrc
| Sets the source reference on Chart Studio Cloud for
| `text`.
| texttemplate
| Template string used for rendering the information text
| that appear on points. Note that this will override
| `textinfo`. Variables are inserted using %{variable},
| for example "y: %{y}". Numbers are formatted using
| d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format
| for details on the formatting syntax. Dates are
| formatted using d3-time-format's syntax
| %{variable|d3-time-format}, for example "Day:
| %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the
| date formatting syntax. Every attributes that can be
| specified per-point (the ones that are `arrayOk: true`)
| are available. Finally, the template string has access
| to variables `initial`, `delta`, `final` and `label`.
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
| totals
| :class:`plotly.graph_objects.waterfall.Totals` instance
| or dict with compatible properties
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and
| transitions.
| uirevision
| Controls persistence of some user-driven changes to the
| trace: `constraintrange` in `parcoords` traces, as well
| as some `editable: true` modifications such as `name`
| and `colorbar.title`. Defaults to `layout.uirevision`.
| Note that other user-driven trace attribute changes are
| controlled by `layout` attributes: `trace.visible` is
| controlled by `layout.legend.uirevision`,
| `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)`
| (accessible with `config: {editable: true}`) is
| controlled by `layout.editrevision`. Trace changes are
| tracked by `uid`, which only falls back on trace index
| if no `uid` is provided. So if your app can add/remove
| traces before the end of the `data` array, such that
| the same trace has a different index, you can still
| preserve user-driven changes if you give each trace a
| `uid` that stays with it as it moves.
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as
| a legend item (provided that the legend itself is
| visible).
| width
| Sets the bar width (in position axis units).
| widthsrc
| Sets the source reference on Chart Studio Cloud for
| `width`.
| x
| Sets the x coordinates.
| x0
| Alternate to `x`. Builds a linear space of x
| coordinates. Use with `dx` where `x0` is the starting
| coordinate and `dx` the step.
| xaxis
| Sets a reference between this trace's x coordinates and
| a 2D cartesian x axis. If "x" (the default value), the
| x coordinates refer to `layout.xaxis`. If "x2", the x
| coordinates refer to `layout.xaxis2`, and so on.
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `xaxis.hoverformat`.
| xperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the x
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| xperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the x0 axis. When `x0period` is round number
| of weeks, the `x0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
| xsrc
| Sets the source reference on Chart Studio Cloud for
| `x`.
| y
| Sets the y coordinates.
| y0
| Alternate to `y`. Builds a linear space of y
| coordinates. Use with `dy` where `y0` is the starting
| coordinate and `dy` the step.
| yaxis
| Sets a reference between this trace's y coordinates and
| a 2D cartesian y axis. If "y" (the default value), the
| y coordinates refer to `layout.yaxis`. If "y2", the y
| coordinates refer to `layout.yaxis2`, and so on.
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3
| formatting mini-languages which are very similar to
| those in Python. For numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
| And for dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to
| d3's date formatter: "%h" for half of the year as a
| decimal number as well as "%{n}f" for fractional
| seconds with n digits. For example, *2016-10-13
| 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
| display *09~15~23.46*By default the values are
| formatted using `yaxis.hoverformat`.
| yperiod
| Only relevant when the axis `type` is "date". Sets the
| period positioning in milliseconds or "M<n>" on the y
| axis. Special values in the form of "M<n>" could be
| used to declare the number of months. In this case `n`
| must be a positive integer.
| yperiod0
| Only relevant when the axis `type` is "date". Sets the
| base for period positioning in milliseconds or date
| string on the y0 axis. When `y0period` is round number
| of weeks, the `y0period0` by default would be on a
| Sunday i.e. 2000-01-02, otherwise it would be at
| 2000-01-01.
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
| ysrc
| Sets the source reference on Chart Studio Cloud for
| `y`.
| zorder
| Sets the layer on which this trace is displayed,
| relative to other SVG traces on the same subplot. SVG
| traces with higher `zorder` appear in front of those
| with lower `zorder`.
|
| Returns
| -------
| Waterfall
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| type
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| alignmentgroup
| Set several traces linked to the same position axis or matching
| axes to the same alignmentgroup. This controls whether bars
| compute their positional range dependently or independently.
|
| The 'alignmentgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| base
| Sets where the bar base is drawn (in position axis units).
|
| The 'base' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| cliponaxis
| Determines whether the text nodes are clipped about the subplot
| axes. To show the text nodes above axis lines and tick labels,
| make sure to set `xaxis.layer` and `yaxis.layer` to *below
| traces*.
|
| The 'cliponaxis' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| connector
| The 'connector' property is an instance of Connector
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Connector`
| - A dict of string/value properties that will be passed
| to the Connector constructor
|
| Supported dict properties:
|
| line
| :class:`plotly.graph_objects.waterfall.connecto
| r.Line` instance or dict with compatible
| properties
| mode
| Sets the shape of connector lines.
| visible
| Determines if connector lines are drawn.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Connector
|
| constraintext
| Constrain the size of text inside or outside a bar to be no
| larger than the bar itself.
|
| The 'constraintext' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'both', 'none']
|
| Returns
| -------
| Any
|
| customdata
| Assigns extra data each datum. This may be useful when
| listening to hover, click and selection events. Note that,
| "scatter" traces also appends customdata items in the markers
| DOM elements
|
| The 'customdata' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| customdatasrc
| Sets the source reference on Chart Studio Cloud for
| `customdata`.
|
| The 'customdatasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| decreasing
| The 'decreasing' property is an instance of Decreasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Decreasing`
| - A dict of string/value properties that will be passed
| to the Decreasing constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.waterfall.decreasi
| ng.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.waterfall.Decreasing
|
| dx
| Sets the x coordinate step. See `x0` for more info.
|
| The 'dx' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| dy
| Sets the y coordinate step. See `y0` for more info.
|
| The 'dy' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| hoverinfo
| Determines which trace information appear on hover. If `none`
| or `skip` are set, no information is displayed upon hovering.
| But, if `none` is set, click and hover events are still fired.
|
| The 'hoverinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters
| (e.g. 'name+x')
| OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
| - A list or array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| hoverinfosrc
| Sets the source reference on Chart Studio Cloud for
| `hoverinfo`.
|
| The 'hoverinfosrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hoverlabel
| The 'hoverlabel' property is an instance of Hoverlabel
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Hoverlabel`
| - A dict of string/value properties that will be passed
| to the Hoverlabel constructor
|
| Supported dict properties:
|
| align
| Sets the horizontal alignment of the text
| content within hover label box. Has an effect
| only if the hover label text spans more two or
| more lines
| alignsrc
| Sets the source reference on Chart Studio Cloud
| for `align`.
| bgcolor
| Sets the background color of the hover labels
| for this trace
| bgcolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bgcolor`.
| bordercolor
| Sets the border color of the hover labels for
| this trace.
| bordercolorsrc
| Sets the source reference on Chart Studio Cloud
| for `bordercolor`.
| font
| Sets the font used in hover labels.
| namelength
| Sets the default length (in number of
| characters) of the trace name in the hover
| labels for all traces. -1 shows the whole name
| regardless of length. 0-3 shows the first 0-3
| characters, and an integer >3 will show the
| whole name if it is less than that many
| characters, but if it is longer, will truncate
| to `namelength - 3` characters and add an
| ellipsis.
| namelengthsrc
| Sets the source reference on Chart Studio Cloud
| for `namelength`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Hoverlabel
|
| hovertemplate
| Template string used for rendering the information that appear
| on hover box. Note that this will override `hoverinfo`.
| Variables are inserted using %{variable}, for example "y: %{y}"
| as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
| showing info for several points, "xother" will be added to
| those with different x positions from the first point. An
| underscore before or after "(x|y)other" will add a space on
| that side, only when this field is shown. Numbers are formatted
| using d3-format's syntax %{variable:d3-format}, for example
| "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. The variables available in `hovertemplate`
| are the ones emitted as event data described at this link
| https://plotly.com/javascript/plotlyjs-events/#event-data.
| Additionally, every attributes that can be specified per-point
| (the ones that are `arrayOk: true`) are available. Finally, the
| template string has access to variables `initial`, `delta` and
| `final`. Anything contained in tag `<extra>` is displayed in
| the secondary box, for example
| "<extra>{fullData.name}</extra>". To hide the secondary box
| completely, use an empty tag `<extra></extra>`.
|
| The 'hovertemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `hovertemplate`.
|
| The 'hovertemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| hovertext
| Sets hover text elements associated with each (x,y) pair. If a
| single string, the same string appears over all the data
| points. If an array of string, the items are mapped in order to
| the this trace's (x,y) coordinates. To be seen, trace
| `hoverinfo` must contain a "text" flag.
|
| The 'hovertext' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| hovertextsrc
| Sets the source reference on Chart Studio Cloud for
| `hovertext`.
|
| The 'hovertextsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| ids
| Assigns id labels to each datum. These ids for object constancy
| of data points during animation. Should be an array of strings,
| not numbers or any other type.
|
| The 'ids' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| idssrc
| Sets the source reference on Chart Studio Cloud for `ids`.
|
| The 'idssrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| increasing
| The 'increasing' property is an instance of Increasing
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Increasing`
| - A dict of string/value properties that will be passed
| to the Increasing constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.waterfall.increasi
| ng.Marker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.waterfall.Increasing
|
| insidetextanchor
| Determines if texts are kept at center or start/end points in
| `textposition` "inside" mode.
|
| The 'insidetextanchor' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['end', 'middle', 'start']
|
| Returns
| -------
| Any
|
| insidetextfont
| Sets the font used for `text` lying inside the bar.
|
| The 'insidetextfont' property is an instance of Insidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Insidetextfont`
| - A dict of string/value properties that will be passed
| to the Insidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Insidetextfont
|
| legend
| Sets the reference to a legend to show this trace in.
| References to these legends are "legend", "legend2", "legend3",
| etc. Settings for these legends are set in the layout, under
| `layout.legend`, `layout.legend2`, etc.
|
| The 'legend' property is an identifier of a particular
| subplot, of type 'legend', that may be specified as the string 'legend'
| optionally followed by an integer >= 1
| (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
| Returns
| -------
| str
|
| legendgroup
| Sets the legend group for this trace. Traces and shapes part of
| the same legend group hide/show at the same time when toggling
| legend items.
|
| The 'legendgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| legendgrouptitle
| The 'legendgrouptitle' property is an instance of Legendgrouptitle
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Legendgrouptitle`
| - A dict of string/value properties that will be passed
| to the Legendgrouptitle constructor
|
| Supported dict properties:
|
| font
| Sets this legend group's title font.
| text
| Sets the title of the legend group.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Legendgrouptitle
|
| legendrank
| Sets the legend rank for this trace. Items and groups with
| smaller ranks are presented on top/left side while with
| "reversed" `legend.traceorder` they are on bottom/right side.
| The default legendrank is 1000, so that you can use ranks less
| than 1000 to place certain items before all unranked items, and
| ranks greater than 1000 to go after all unranked items. When
| having unranked or equal rank items shapes would be displayed
| after traces i.e. according to their order in data and layout.
|
| The 'legendrank' property is a number and may be specified as:
| - An int or float
|
| Returns
| -------
| int|float
|
| legendwidth
| Sets the width (in px or fraction) of the legend for this
| trace.
|
| The 'legendwidth' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
|
| Returns
| -------
| int|float
|
| measure
| An array containing types of values. By default the values are
| considered as 'relative'. However; it is possible to use
| 'total' to compute the sums. Also 'absolute' could be applied
| to reset the computed total or to declare an initial value
| where needed.
|
| The 'measure' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| measuresrc
| Sets the source reference on Chart Studio Cloud for `measure`.
|
| The 'measuresrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| meta
| Assigns extra meta information associated with this trace that
| can be used in various text attributes. Attributes such as
| trace `name`, graph, axis and colorbar `title.text`, annotation
| `text` `rangeselector`, `updatemenues` and `sliders` `label`
| text all support `meta`. To access the trace `meta` values in
| an attribute in the same trace, simply use `%{meta[i]}` where
| `i` is the index or key of the `meta` item in question. To
| access trace `meta` in layout attributes, use
| `%{data[n[.meta[i]}` where `i` is the index or key of the
| `meta` and `n` is the trace index.
|
| The 'meta' property accepts values of any type
|
| Returns
| -------
| Any|numpy.ndarray
|
| metasrc
| Sets the source reference on Chart Studio Cloud for `meta`.
|
| The 'metasrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| name
| Sets the trace name. The trace name appears as the legend item
| and on hover.
|
| The 'name' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offset
| Shifts the position where the bar is drawn (in position axis
| units). In "group" barmode, traces that set "offset" will be
| excluded and drawn in "overlay" mode instead.
|
| The 'offset' property is a number and may be specified as:
| - An int or float
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| offsetgroup
| Set several traces linked to the same position axis or matching
| axes to the same offsetgroup where bars of the same position
| coordinate will line up.
|
| The 'offsetgroup' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| offsetsrc
| Sets the source reference on Chart Studio Cloud for `offset`.
|
| The 'offsetsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| opacity
| Sets the opacity of the trace.
|
| The 'opacity' property is a number and may be specified as:
| - An int or float in the interval [0, 1]
|
| Returns
| -------
| int|float
|
| orientation
| Sets the orientation of the bars. With "v" ("h"), the value of
| the each bar spans along the vertical (horizontal).
|
| The 'orientation' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['v', 'h']
|
| Returns
| -------
| Any
|
| outsidetextfont
| Sets the font used for `text` lying outside the bar.
|
| The 'outsidetextfont' property is an instance of Outsidetextfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont`
| - A dict of string/value properties that will be passed
| to the Outsidetextfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Outsidetextfont
|
| selectedpoints
| Array containing integer indices of selected points. Has an
| effect only for traces that support selections. Note that an
| empty array means an empty selection where the `unselected` are
| turned on for all points, whereas, any other non-array values
| means no selection all where the `selected` and `unselected`
| styles have no effect.
|
| The 'selectedpoints' property accepts values of any type
|
| Returns
| -------
| Any
|
| showlegend
| Determines whether or not an item corresponding to this trace
| is shown in the legend.
|
| The 'showlegend' property must be specified as a bool
| (either True, or False)
|
| Returns
| -------
| bool
|
| stream
| The 'stream' property is an instance of Stream
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Stream`
| - A dict of string/value properties that will be passed
| to the Stream constructor
|
| Supported dict properties:
|
| maxpoints
| Sets the maximum number of points to keep on
| the plots from an incoming stream. If
| `maxpoints` is set to 50, only the newest 50
| points will be displayed on the plot.
| token
| The stream id number links a data trace on a
| plot with a stream. See https://chart-
| studio.plotly.com/settings for more details.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Stream
|
| text
| Sets text elements associated with each (x,y) pair. If a single
| string, the same string appears over all the data points. If an
| array of string, the items are mapped in order to the this
| trace's (x,y) coordinates. If trace `hoverinfo` contains a
| "text" flag and "hovertext" is not set, these elements will be
| seen in the hover labels.
|
| The 'text' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| textangle
| Sets the angle of the tick labels with respect to the bar. For
| example, a `tickangle` of -90 draws the tick labels vertically.
| With "auto" the texts may automatically be rotated to fit with
| the maximum size in bars.
|
| The 'textangle' property is a angle (in degrees) that may be
| specified as a number between -180 and 180.
| Numeric values outside this range are converted to the equivalent value
| (e.g. 270 is converted to -90).
|
| Returns
| -------
| int|float
|
| textfont
| Sets the font used for `text`.
|
| The 'textfont' property is an instance of Textfont
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Textfont`
| - A dict of string/value properties that will be passed
| to the Textfont constructor
|
| Supported dict properties:
|
| color
|
| colorsrc
| Sets the source reference on Chart Studio Cloud
| for `color`.
| family
| HTML font family - the typeface that will be
| applied by the web browser. The web browser
| will only be able to apply a font if it is
| available on the system which it operates.
| Provide multiple font families, separated by
| commas, to indicate the preference in which to
| apply fonts if they aren't available on the
| system. The Chart Studio Cloud (at
| https://chart-studio.plotly.com or on-premise)
| generates images on a server, where only a
| select number of fonts are installed and
| supported. These include "Arial", "Balto",
| "Courier New", "Droid Sans", "Droid Serif",
| "Droid Sans Mono", "Gravitas One", "Old
| Standard TT", "Open Sans", "Overpass", "PT Sans
| Narrow", "Raleway", "Times New Roman".
| familysrc
| Sets the source reference on Chart Studio Cloud
| for `family`.
| lineposition
| Sets the kind of decoration line(s) with text,
| such as an "under", "over" or "through" as well
| as combinations e.g. "under+over", etc.
| linepositionsrc
| Sets the source reference on Chart Studio Cloud
| for `lineposition`.
| shadow
| Sets the shape and color of the shadow behind
| text. "auto" places minimal shadow and applies
| contrast text font color. See
| https://developer.mozilla.org/en-
| US/docs/Web/CSS/text-shadow for additional
| options.
| shadowsrc
| Sets the source reference on Chart Studio Cloud
| for `shadow`.
| size
|
| sizesrc
| Sets the source reference on Chart Studio Cloud
| for `size`.
| style
| Sets whether a font should be styled with a
| normal or italic face from its family.
| stylesrc
| Sets the source reference on Chart Studio Cloud
| for `style`.
| textcase
| Sets capitalization of text. It can be used to
| make text appear in all-uppercase or all-
| lowercase, or with each word capitalized.
| textcasesrc
| Sets the source reference on Chart Studio Cloud
| for `textcase`.
| variant
| Sets the variant of the font.
| variantsrc
| Sets the source reference on Chart Studio Cloud
| for `variant`.
| weight
| Sets the weight (or boldness) of the font.
| weightsrc
| Sets the source reference on Chart Studio Cloud
| for `weight`.
|
| Returns
| -------
| plotly.graph_objs.waterfall.Textfont
|
| textinfo
| Determines which trace information appear on the graph. In the
| case of having multiple waterfalls, totals are computed
| separately (per trace).
|
| The 'textinfo' property is a flaglist and may be specified
| as a string containing:
| - Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters
| (e.g. 'label+text')
| OR exactly one of ['none'] (e.g. 'none')
|
| Returns
| -------
| Any
|
| textposition
| Specifies the location of the `text`. "inside" positions `text`
| inside, next to the bar end (rotated and scaled if needed).
| "outside" positions `text` outside, next to the bar end (scaled
| if needed), unless there is another bar stacked on this one,
| then the text gets pushed inside. "auto" tries to position
| `text` inside the bar, but if the bar is too small and no bar
| is stacked on this one the text is moved outside. If "none", no
| text appears.
|
| The 'textposition' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['inside', 'outside', 'auto', 'none']
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| Any|numpy.ndarray
|
| textpositionsrc
| Sets the source reference on Chart Studio Cloud for
| `textposition`.
|
| The 'textpositionsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| textsrc
| Sets the source reference on Chart Studio Cloud for `text`.
|
| The 'textsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| texttemplate
| Template string used for rendering the information text that
| appear on points. Note that this will override `textinfo`.
| Variables are inserted using %{variable}, for example "y:
| %{y}". Numbers are formatted using d3-format's syntax
| %{variable:d3-format}, for example "Price: %{y:$.2f}".
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
| details on the formatting syntax. Dates are formatted using
| d3-time-format's syntax %{variable|d3-time-format}, for example
| "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format for details on the date
| formatting syntax. Every attributes that can be specified per-
| point (the ones that are `arrayOk: true`) are available.
| Finally, the template string has access to variables `initial`,
| `delta`, `final` and `label`.
|
| The 'texttemplate' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| str|numpy.ndarray
|
| texttemplatesrc
| Sets the source reference on Chart Studio Cloud for
| `texttemplate`.
|
| The 'texttemplatesrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| totals
| The 'totals' property is an instance of Totals
| that may be specified as:
| - An instance of :class:`plotly.graph_objs.waterfall.Totals`
| - A dict of string/value properties that will be passed
| to the Totals constructor
|
| Supported dict properties:
|
| marker
| :class:`plotly.graph_objects.waterfall.totals.M
| arker` instance or dict with compatible
| properties
|
| Returns
| -------
| plotly.graph_objs.waterfall.Totals
|
| uid
| Assign an id to this trace, Use this to provide object
| constancy between traces during animations and transitions.
|
| The 'uid' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| uirevision
| Controls persistence of some user-driven changes to the trace:
| `constraintrange` in `parcoords` traces, as well as some
| `editable: true` modifications such as `name` and
| `colorbar.title`. Defaults to `layout.uirevision`. Note that
| other user-driven trace attribute changes are controlled by
| `layout` attributes: `trace.visible` is controlled by
| `layout.legend.uirevision`, `selectedpoints` is controlled by
| `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
| with `config: {editable: true}`) is controlled by
| `layout.editrevision`. Trace changes are tracked by `uid`,
| which only falls back on trace index if no `uid` is provided.
| So if your app can add/remove traces before the end of the
| `data` array, such that the same trace has a different index,
| you can still preserve user-driven changes if you give each
| trace a `uid` that stays with it as it moves.
|
| The 'uirevision' property accepts values of any type
|
| Returns
| -------
| Any
|
| visible
| Determines whether or not this trace is visible. If
| "legendonly", the trace is not drawn, but can appear as a
| legend item (provided that the legend itself is visible).
|
| The 'visible' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| [True, False, 'legendonly']
|
| Returns
| -------
| Any
|
| width
| Sets the bar width (in position axis units).
|
| The 'width' property is a number and may be specified as:
| - An int or float in the interval [0, inf]
| - A tuple, list, or one-dimensional numpy array of the above
|
| Returns
| -------
| int|float|numpy.ndarray
|
| widthsrc
| Sets the source reference on Chart Studio Cloud for `width`.
|
| The 'widthsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| x
| Sets the x coordinates.
|
| The 'x' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| x0
| Alternate to `x`. Builds a linear space of x coordinates. Use
| with `dx` where `x0` is the starting coordinate and `dx` the
| step.
|
| The 'x0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xaxis
| Sets a reference between this trace's x coordinates and a 2D
| cartesian x axis. If "x" (the default value), the x coordinates
| refer to `layout.xaxis`. If "x2", the x coordinates refer to
| `layout.xaxis2`, and so on.
|
| The 'xaxis' property is an identifier of a particular
| subplot, of type 'x', that may be specified as the string 'x'
| optionally followed by an integer >= 1
| (e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
| Returns
| -------
| str
|
| xhoverformat
| Sets the hover text formatting rulefor `x` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `xaxis.hoverformat`.
|
| The 'xhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| xperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the x axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'xperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the x0
| axis. When `x0period` is round number of weeks, the `x0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'xperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| xperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the x axis.
|
| The 'xperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| xsrc
| Sets the source reference on Chart Studio Cloud for `x`.
|
| The 'xsrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| y
| Sets the y coordinates.
|
| The 'y' property is an array that may be specified as a tuple,
| list, numpy array, or pandas Series
|
| Returns
| -------
| numpy.ndarray
|
| y0
| Alternate to `y`. Builds a linear space of y coordinates. Use
| with `dy` where `y0` is the starting coordinate and `dy` the
| step.
|
| The 'y0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yaxis
| Sets a reference between this trace's y coordinates and a 2D
| cartesian y axis. If "y" (the default value), the y coordinates
| refer to `layout.yaxis`. If "y2", the y coordinates refer to
| `layout.yaxis2`, and so on.
|
| The 'yaxis' property is an identifier of a particular
| subplot, of type 'y', that may be specified as the string 'y'
| optionally followed by an integer >= 1
| (e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
| Returns
| -------
| str
|
| yhoverformat
| Sets the hover text formatting rulefor `y` using d3 formatting
| mini-languages which are very similar to those in Python. For
| numbers, see:
| https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for
| dates see: https://github.com/d3/d3-time-
| format/tree/v2.2.3#locale_format. We add two items to d3's date
| formatter: "%h" for half of the year as a decimal number as
| well as "%{n}f" for fractional seconds with n digits. For
| example, *2016-10-13 09:15:23.456* with tickformat
| "%H~%M~%S.%2f" would display *09~15~23.46*By default the values
| are formatted using `yaxis.hoverformat`.
|
| The 'yhoverformat' property is a string and must be specified as:
| - A string
| - A number that will be converted to a string
|
| Returns
| -------
| str
|
| yperiod
| Only relevant when the axis `type` is "date". Sets the period
| positioning in milliseconds or "M<n>" on the y axis. Special
| values in the form of "M<n>" could be used to declare the
| number of months. In this case `n` must be a positive integer.
|
| The 'yperiod' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiod0
| Only relevant when the axis `type` is "date". Sets the base for
| period positioning in milliseconds or date string on the y0
| axis. When `y0period` is round number of weeks, the `y0period0`
| by default would be on a Sunday i.e. 2000-01-02, otherwise it
| would be at 2000-01-01.
|
| The 'yperiod0' property accepts values of any type
|
| Returns
| -------
| Any
|
| yperiodalignment
| Only relevant when the axis `type` is "date". Sets the
| alignment of data points on the y axis.
|
| The 'yperiodalignment' property is an enumeration that may be specified as:
| - One of the following enumeration values:
| ['start', 'middle', 'end']
|
| Returns
| -------
| Any
|
| ysrc
| Sets the source reference on Chart Studio Cloud for `y`.
|
| The 'ysrc' property must be specified as a string or
| as a plotly.grid_objs.Column object
|
| Returns
| -------
| str
|
| zorder
| Sets the layer on which this trace is displayed, relative to
| other SVG traces on the same subplot. SVG traces with higher
| `zorder` appear in front of those with lower `zorder`.
|
| The 'zorder' property is a integer and may be specified as:
| - An int (or float that will be cast to an int)
|
| Returns
| -------
| int
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BaseTraceType:
|
| on_click(self, callback, append=False)
| Register function to be called when the user clicks on one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_click callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def click_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_click(click_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `click_fn`
|
| on_deselect(self, callback, append=False)
| Register function to be called when the user deselects points
| in this trace using doubleclick.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_deselect callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def deselect_fn(trace, points):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_deselect(deselect_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_hover(self, callback, append=False)
| Register function to be called when the user hovers over one or more
| points in this trace
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_hover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def hover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_hover(hover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `hover_fn`
|
| on_selection(self, callback, append=False)
| Register function to be called when the user selects one or more
| points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 4 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.BoxSelector or plotly.callbacks.LassoSelector
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_selection callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points
| >>> points = Points()
|
| >>> def selection_fn(trace, points, selector):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_selection(selection_fn)
|
| Note: The creation of the `points` object is optional,
| it's simply a convenience to help the text editor perform completion
| on the `points` arguments inside `selection_fn`
|
| on_unhover(self, callback, append=False)
| Register function to be called when the user unhovers away from one
| or more points in this trace.
|
| Note: Callbacks will only be triggered when the trace belongs to a
| instance of plotly.graph_objs.FigureWidget and it is displayed in an
| ipywidget context. Callbacks will not be triggered on figures
| that are displayed using plot/iplot.
|
| Parameters
| ----------
| callback
| Callable function that accepts 3 arguments
|
| - this trace
| - plotly.callbacks.Points object
| - plotly.callbacks.InputDeviceState object
|
| append : bool
| If False (the default), this callback replaces any previously
| defined on_unhover callbacks for this trace. If True,
| this callback is appended to the list of any previously defined
| callbacks.
|
| Returns
| -------
| None
|
| Examples
| --------
|
| >>> import plotly.graph_objects as go
| >>> from plotly.callbacks import Points, InputDeviceState
| >>> points, state = Points(), InputDeviceState()
|
| >>> def unhover_fn(trace, points, state):
| ... inds = points.point_inds
| ... # Do something
|
| >>> trace = go.Scatter(x=[1, 2], y=[3, 0])
| >>> trace.on_unhover(unhover_fn)
|
| Note: The creation of the `points` and `state` objects is optional,
| it's simply a convenience to help the text editor perform completion
| on the arguments inside `unhover_fn`
|
| ----------------------------------------------------------------------
| Methods inherited from plotly.basedatatypes.BasePlotlyType:
|
| __contains__(self, prop)
| Determine whether object contains a property or nested property
|
| Parameters
| ----------
| prop : str|tuple
| If prop is a simple string (e.g. 'foo'), then return true of the
| object contains an element named 'foo'
|
| If prop is a property path string (e.g. 'foo[0].bar'),
| then return true if the obejct contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| If prop is a property path tuple (e.g. ('foo', 0, 'bar')),
| then return true if the object contains the nested elements for
| each entry in the path string (e.g. 'bar' in obj['foo'][0])
|
| Returns
| -------
| bool
|
| __eq__(self, other)
| Test for equality
|
| To be considered equal, `other` must have the same type as this object
| and their `to_plotly_json` representaitons must be identical.
|
| Parameters
| ----------
| other
| The object to compare against
|
| Returns
| -------
| bool
|
| __getitem__(self, prop)
| Get item or nested item from object
|
| Parameters
| ----------
| prop : str|tuple
|
| If prop is the name of a property of this object, then the
| property is returned.
|
| If prop is a nested property path string (e.g. 'foo[1].bar'),
| then a nested property is returned (e.g. obj['foo'][1]['bar'])
|
| If prop is a path tuple (e.g. ('foo', 1, 'bar')), then a nested
| property is returned (e.g. obj['foo'][1]['bar']).
|
| Returns
| -------
| Any
|
| __iter__(self)
| Return an iterator over the object's properties
|
| __reduce__(self)
| Custom implementation of reduce is used to support deep copying
| and pickling
|
| __repr__(self)
| Customize object 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)
| Parameters
| ----------
| prop : str
| The name of a direct child of this object
|
| Note: Setting nested properties using property path string or
| property path tuples is not supported.
| value
| New property value
|
| Returns
| -------
| None
|
| on_change(self, callback, *args, **kwargs)
| Register callback function to be called when certain properties or
| subproperties of this object are modified.
|
| Callback will be invoked whenever ANY of these properties is
| modified. Furthermore, the callback will only be invoked once even
| if multiple properties are modified during the same restyle /
| relayout / update operation.
|
| Parameters
| ----------
| callback : function
| Function that accepts 1 + len(`args`) parameters. First parameter
| is this object. Second through last parameters are the
| property / subpropery values referenced by args.
| args : list[str|tuple[int|str]]
| List of property references where each reference may be one of:
|
| 1) A property name string (e.g. 'foo') for direct properties
| 2) A property path string (e.g. 'foo[0].bar') for
| subproperties
| 3) A property path tuple (e.g. ('foo', 0, 'bar')) for
| subproperties
|
| append : bool
| True if callback should be appended to previously registered
| callback on the same properties, False if callback should replace
| previously registered callbacks on the same properties. Defaults
| to False.
|
| Examples
| --------
|
| Register callback that prints out the range extents of the xaxis and
| yaxis whenever either either of them changes.
|
| >>> import plotly.graph_objects as go
| >>> fig = go.Figure(go.Scatter(x=[1, 2], y=[1, 0]))
| >>> fig.layout.on_change(
| ... lambda obj, xrange, yrange: print("%s-%s" % (xrange, yrange)),
| ... ('xaxis', 'range'), ('yaxis', 'range'))
|
|
| Returns
| -------
| None
|
| pop(self, key, *args)
| Remove the value associated with the specified key and return it
|
| Parameters
| ----------
| key: str
| Property name
| dflt
| The default value to return if key was not found in object
|
| Returns
| -------
| value
| The removed value that was previously associated with key
|
| Raises
| ------
| KeyError
| If key is not in object and no dflt argument specified
|
| to_json(self, *args, **kwargs)
| Convert object to a JSON string representation
|
| Parameters
| ----------
| validate: bool (default True)
| True if the object should be validated before being converted to
| JSON, False otherwise.
|
| pretty: bool (default False)
| True if JSON representation should be pretty-printed, False if
| representation should be as compact as possible.
|
| remove_uids: bool (default True)
| True if trace UIDs should be omitted from the JSON representation
|
| engine: str (default None)
| The JSON encoding engine to use. One of:
| - "json" for an encoder based on the built-in Python json module
| - "orjson" for a fast encoder the requires the orjson package
| If not specified, the default encoder is set to the current value of
| plotly.io.json.config.default_encoder.
|
| Returns
| -------
| str
| Representation of object as a JSON string
|
| to_plotly_json(self)
| Return plotly JSON representation of object as a Python dict
|
| Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util
| or the `to_json` method to encode to a string.
|
| Returns
| -------
| dict
|
| update(self, dict1=None, overwrite=False, **kwargs)
| Update the properties of an object with a dict and/or with
| keyword arguments.
|
| This recursively updates the structure of the original
| object with the values in the input dict / keyword arguments.
|
| Parameters
| ----------
| dict1 : dict
| Dictionary of properties to be updated
| overwrite: bool
| If True, overwrite existing properties. If False, apply updates
| to existing properties recursively, preserving existing
| properties that are not specified in the update operation.
| kwargs :
| Keyword/value pair of properties to be updated
|
| Returns
| -------
| BasePlotlyType
| Updated plotly object
|
| ----------------------------------------------------------------------
| Readonly properties inherited from plotly.basedatatypes.BasePlotlyType:
|
| figure
| Reference to the top-level Figure or FigureWidget that this object
| belongs to. None if the object does not belong to a Figure
|
| Returns
| -------
| Union[BaseFigure, None]
|
| parent
| Return the object's parent, or None if the object has no parent
| Returns
| -------
| BasePlotlyType|BaseFigure
|
| plotly_name
| The plotly name of the object
|
| Returns
| -------
| str
|
| ----------------------------------------------------------------------
| Data descriptors inherited from plotly.basedatatypes.BasePlotlyType:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from plotly.basedatatypes.BasePlotlyType:
|
| __hash__ = None
class XAxis(builtins.dict)
| XAxis(*args, **kwargs)
|
| plotly.graph_objs.XAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.XAxis
| - plotly.graph_objs.layout.scene.XAxis
|
| Method resolution order:
| XAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.XAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.XAxis
| - plotly.graph_objs.layout.scene.XAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class XBins(builtins.dict)
| XBins(*args, **kwargs)
|
| plotly.graph_objs.XBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.XBins
| - plotly.graph_objs.histogram2d.XBins
|
| Method resolution order:
| XBins
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.XBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.XBins
| - plotly.graph_objs.histogram2d.XBins
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class YAxis(builtins.dict)
| YAxis(*args, **kwargs)
|
| plotly.graph_objs.YAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.YAxis
| - plotly.graph_objs.layout.scene.YAxis
|
| Method resolution order:
| YAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.YAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.YAxis
| - plotly.graph_objs.layout.scene.YAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class YBins(builtins.dict)
| YBins(*args, **kwargs)
|
| plotly.graph_objs.YBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.YBins
| - plotly.graph_objs.histogram2d.YBins
|
| Method resolution order:
| YBins
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.YBins is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.histogram.YBins
| - plotly.graph_objs.histogram2d.YBins
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class ZAxis(builtins.dict)
| ZAxis(*args, **kwargs)
|
| plotly.graph_objs.ZAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.scene.ZAxis
|
| Method resolution order:
| ZAxis
| builtins.dict
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| plotly.graph_objs.ZAxis is deprecated.
| Please replace it with one of the following more specific types
| - plotly.graph_objs.layout.scene.ZAxis
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.dict:
|
| __contains__(self, key, /)
| True if the dictionary has the specified key, else False.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the dict keys.
|
| __ror__(self, value, /)
| Return value|self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(...)
| D.__sizeof__() -> size of D in memory, in bytes
|
| clear(...)
| D.clear() -> None. Remove all items from D.
|
| copy(...)
| D.copy() -> a shallow copy of D
|
| get(self, key, default=None, /)
| Return the value for key if key is in the dictionary, else default.
|
| items(...)
| D.items() -> a set-like object providing a view on D's items
|
| keys(...)
| D.keys() -> a set-like object providing a view on D's keys
|
| pop(...)
| D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
|
| If the key is not found, return the default if given; otherwise,
| raise a KeyError.
|
| popitem(self, /)
| Remove and return a (key, value) pair as a 2-tuple.
|
| Pairs are returned in LIFO (last-in, first-out) order.
| Raises KeyError if the dict is empty.
|
| setdefault(self, key, default=None, /)
| Insert key with a value of default if key is not in the dictionary.
|
| Return the value for key if key is in the dictionary, else default.
|
| update(...)
| D.update([E, ]**F) -> None. Update D from dict/iterable E and F.
| If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
| In either case, this is followed by: for k in F: D[k] = F[k]
|
| values(...)
| D.values() -> an object providing a view on D's values
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.dict:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\graph_objs\__init__.py
plotly.io
Python Library Documentation: package plotly.io in plotly
NAME
plotly.io
PACKAGE CONTENTS
_base_renderers
_html
_json
_kaleido
_orca
_renderers
_sg_scraper
_templates
_utils
base_renderers
json
kaleido
orca
FUNCTIONS
from_json(value, output_type='Figure', skip_invalid=False, engine=None)
Construct a figure from a JSON string
Parameters
----------
value: str or bytes
String or bytes object containing the JSON representation of a figure
output_type: type or str (default 'Figure')
The output figure type or type name.
One of: graph_objs.Figure, 'Figure', graph_objs.FigureWidget, 'FigureWidget'
skip_invalid: bool (default False)
False if invalid figure properties should result in an exception.
True if invalid figure properties should be silently ignored.
engine: str (default None)
The JSON decoding engine to use. One of:
- if "json", parse JSON using built in json module
- if "orjson", parse using the faster orjson module, requires the orjson
package
- if "auto" use orjson module if available, otherwise use the json module
If not specified, the default engine is set to the current value of
plotly.io.json.config.default_engine.
Raises
------
ValueError
if value is not a string, or if skip_invalid=False and value contains
invalid figure properties
Returns
-------
Figure or FigureWidget
full_figure_for_development(fig, warn=True, as_dict=False)
Compute default values for all attributes not specified in the input figure and
returns the output as a "full" figure. This function calls Plotly.js via Kaleido
to populate unspecified attributes. This function is intended for interactive use
during development to learn more about how Plotly.js computes default values and is
not generally necessary or recommended for production use.
Parameters
----------
fig:
Figure object or dict representing a figure
warn: bool
If False, suppress warnings about not using this in production.
as_dict: bool
If True, output is a dict with some keys that go.Figure can't parse.
If False, output is a go.Figure with unparseable keys skipped.
Returns
-------
plotly.graph_objects.Figure or dict
The full figure
read_json(file, output_type='Figure', skip_invalid=False, engine=None)
Construct a figure from the JSON contents of a local file or readable
Python object
Parameters
----------
file: str or readable
A string containing the path to a local file or a read-able Python
object (e.g. a pathlib.Path object or an open file descriptor)
output_type: type or str (default 'Figure')
The output figure type or type name.
One of: graph_objs.Figure, 'Figure', graph_objs.FigureWidget, 'FigureWidget'
skip_invalid: bool (default False)
False if invalid figure properties should result in an exception.
True if invalid figure properties should be silently ignored.
engine: str (default None)
The JSON decoding engine to use. One of:
- if "json", parse JSON using built in json module
- if "orjson", parse using the faster orjson module, requires the orjson
package
- if "auto" use orjson module if available, otherwise use the json module
If not specified, the default engine is set to the current value of
plotly.io.json.config.default_engine.
Returns
-------
Figure or FigureWidget
show(fig, renderer=None, validate=True, **kwargs)
Show a figure using either the default renderer(s) or the renderer(s)
specified by the renderer argument
Parameters
----------
fig: dict of Figure
The Figure object or figure dict to display
renderer: str or None (default None)
A string containing the names of one or more registered renderers
(separated by '+' characters) or None. If None, then the default
renderers specified in plotly.io.renderers.default are used.
validate: bool (default True)
True if the figure should be validated before being shown,
False otherwise.
width: int or float
An integer or float that determines the number of pixels wide the
plot is. The default is set in plotly.js.
height: int or float
An integer or float that determines the number of pixels wide the
plot is. The default is set in plotly.js.
config: dict
A dict of parameters to configure the figure. The defaults are set
in plotly.js.
Returns
-------
None
to_html(fig, config=None, auto_play=True, include_plotlyjs=True, include_mathjax=False, post_script=None, full_html=True, animation_opts=None, default_width='100%', default_height='100%', validate=True, div_id=None)
Convert a figure to an HTML string representation.
Parameters
----------
fig:
Figure object or dict representing a figure
config: dict or None (default None)
Plotly.js figure config options
auto_play: bool (default=True)
Whether to automatically start the animation sequence on page load
if the figure contains frames. Has no effect if the figure does not
contain frames.
include_plotlyjs: bool or string (default True)
Specifies how the plotly.js library is included/loaded in the output
div string.
If True, a script tag containing the plotly.js source code (~3MB)
is included in the output. HTML files generated with this option are
fully self-contained and can be used offline.
If 'cdn', a script tag that references the plotly.js CDN is included
in the output. The url used is versioned to match the bundled plotly.js.
HTML files generated with this option are about 3MB smaller than those
generated with include_plotlyjs=True, but they require an active
internet connection in order to load the plotly.js library.
If 'directory', a script tag is included that references an external
plotly.min.js bundle that is assumed to reside in the same
directory as the HTML file.
If 'require', Plotly.js is loaded using require.js. This option
assumes that require.js is globally available and that it has been
globally configured to know how to find Plotly.js as 'plotly'.
This option is not advised when full_html=True as it will result
in a non-functional html file.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point
the resulting HTML file to an alternative CDN or local bundle.
If False, no script tag referencing plotly.js is included. This is
useful when the resulting div string will be placed inside an HTML
document that already loads plotly.js. This option is not advised
when full_html=True as it will result in a non-functional html file.
include_mathjax: bool or string (default False)
Specifies how the MathJax.js library is included in the output html
div string. MathJax is required in order to display labels
with LaTeX typesetting.
If False, no script tag referencing MathJax.js will be included in the
output.
If 'cdn', a script tag that references a MathJax CDN location will be
included in the output. HTML div strings generated with this option
will be able to display LaTeX typesetting as long as internet access
is available.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point the
resulting HTML div string to an alternative CDN.
post_script: str or list or None (default None)
JavaScript snippet(s) to be included in the resulting div just after
plot creation. The string(s) may include '{plot_id}' placeholders
that will then be replaced by the `id` of the div element that the
plotly.js figure is associated with. One application for this script
is to install custom plotly.js event handlers.
full_html: bool (default True)
If True, produce a string containing a complete HTML document
starting with an <html> tag. If False, produce a string containing
a single <div> element.
animation_opts: dict or None (default None)
dict of custom animation parameters to be passed to the function
Plotly.animate in Plotly.js. See
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
for available options. Has no effect if the figure does not contain
frames, or auto_play is False.
default_width, default_height: number or str (default '100%')
The default figure width/height to use if the provided figure does not
specify its own layout.width/layout.height property. May be
specified in pixels as an integer (e.g. 500), or as a css width style
string (e.g. '500px', '100%').
validate: bool (default True)
True if the figure should be validated before being converted to
JSON, False otherwise.
div_id: str (default None)
If provided, this is the value of the id attribute of the div tag. If None, the
id attribute is a UUID.
Returns
-------
str
Representation of figure as an HTML div string
to_image(fig, format=None, width=None, height=None, scale=None, validate=True, engine='auto')
Convert a figure to a static image bytes string
Parameters
----------
fig:
Figure object or dict representing a figure
format: str or None
The desired image format. One of
- 'png'
- 'jpg' or 'jpeg'
- 'webp'
- 'svg'
- 'pdf'
- 'eps' (Requires the poppler library to be installed and on the PATH)
If not specified, will default to:
- `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
- `plotly.io.orca.config.default_format` if engine is "orca"
width: int or None
The width of the exported image in layout pixels. If the `scale`
property is 1.0, this will also be the width of the exported image
in physical pixels.
If not specified, will default to:
- `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
- `plotly.io.orca.config.default_width` if engine is "orca"
height: int or None
The height of the exported image in layout pixels. If the `scale`
property is 1.0, this will also be the height of the exported image
in physical pixels.
If not specified, will default to:
- `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
- `plotly.io.orca.config.default_height` if engine is "orca"
scale: int or float or None
The scale factor to use when exporting the figure. A scale factor
larger than 1.0 will increase the image resolution with respect
to the figure's layout pixel dimensions. Whereas as scale factor of
less than 1.0 will decrease the image resolution.
If not specified, will default to:
- `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
- `plotly.io.orca.config.default_scale` if engine is "orca"
validate: bool
True if the figure should be validated before being converted to
an image, False otherwise.
engine: str
Image export engine to use:
- "kaleido": Use Kaleido for image export
- "orca": Use Orca for image export
- "auto" (default): Use Kaleido if installed, otherwise use orca
Returns
-------
bytes
The image data
to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None)
Convert a figure to a JSON string representation
Parameters
----------
fig:
Figure object or dict representing a figure
validate: bool (default True)
True if the figure should be validated before being converted to
JSON, False otherwise.
pretty: bool (default False)
True if JSON representation should be pretty-printed, False if
representation should be as compact as possible.
remove_uids: bool (default True)
True if trace UIDs should be omitted from the JSON representation
engine: str (default None)
The JSON encoding engine to use. One of:
- "json" for an engine based on the built-in Python json module
- "orjson" for a faster engine that requires the orjson package
- "auto" for the "orjson" engine if available, otherwise "json"
If not specified, the default engine is set to the current value of
plotly.io.json.config.default_engine.
Returns
-------
str
Representation of figure as a JSON string
See Also
--------
to_json_plotly : Convert an arbitrary plotly graph_object or Dash component to JSON
to_templated(fig, skip=('title', 'text'))
Return a copy of a figure where all styling properties have been moved
into the figure's template. The template property of the resulting figure
may then be used to set the default styling of other figures.
Parameters
----------
fig
Figure object or dict representing a figure
skip
A collection of names of properties to skip when moving properties to
the template. Defaults to ('title', 'text') so that the text
of figure titles, axis titles, and annotations does not become part of
the template
Examples
--------
Imports
>>> import plotly.graph_objs as go
>>> import plotly.io as pio
Construct a figure with large courier text
>>> fig = go.Figure(layout={'title': 'Figure Title',
... 'font': {'size': 20, 'family': 'Courier'},
... 'template':"none"})
>>> fig # doctest: +NORMALIZE_WHITESPACE
Figure({
'data': [],
'layout': {'font': {'family': 'Courier', 'size': 20},
'template': '...', 'title': {'text': 'Figure Title'}}
})
Convert to a figure with a template. Note how the 'font' properties have
been moved into the template property.
>>> templated_fig = pio.to_templated(fig)
>>> templated_fig.layout.template
layout.Template({
'layout': {'font': {'family': 'Courier', 'size': 20}}
})
>>> templated_fig
Figure({
'data': [], 'layout': {'template': '...', 'title': {'text': 'Figure Title'}}
})
Next create a new figure with this template
>>> fig2 = go.Figure(layout={
... 'title': 'Figure 2 Title',
... 'template': templated_fig.layout.template})
>>> fig2.layout.template
layout.Template({
'layout': {'font': {'family': 'Courier', 'size': 20}}
})
The default font in fig2 will now be size 20 Courier.
Next, register as a named template...
>>> pio.templates['large_courier'] = templated_fig.layout.template
and specify this template by name when constructing a figure.
>>> go.Figure(layout={
... 'title': 'Figure 3 Title',
... 'template': 'large_courier'}) # doctest: +ELLIPSIS
Figure(...)
Finally, set this as the default template to be applied to all new figures
>>> pio.templates.default = 'large_courier'
>>> fig = go.Figure(layout={'title': 'Figure 4 Title'})
>>> fig.layout.template
layout.Template({
'layout': {'font': {'family': 'Courier', 'size': 20}}
})
Returns
-------
go.Figure
write_html(fig, file, config=None, auto_play=True, include_plotlyjs=True, include_mathjax=False, post_script=None, full_html=True, animation_opts=None, validate=True, default_width='100%', default_height='100%', auto_open=False, div_id=None)
Write a figure to an HTML file representation
Parameters
----------
fig:
Figure object or dict representing a figure
file: str or writeable
A string representing a local file path or a writeable object
(e.g. a pathlib.Path object or an open file descriptor)
config: dict or None (default None)
Plotly.js figure config options
auto_play: bool (default=True)
Whether to automatically start the animation sequence on page load
if the figure contains frames. Has no effect if the figure does not
contain frames.
include_plotlyjs: bool or string (default True)
Specifies how the plotly.js library is included/loaded in the output
div string.
If True, a script tag containing the plotly.js source code (~3MB)
is included in the output. HTML files generated with this option are
fully self-contained and can be used offline.
If 'cdn', a script tag that references the plotly.js CDN is included
in the output. The url used is versioned to match the bundled plotly.js.
HTML files generated with this option are about 3MB smaller than those
generated with include_plotlyjs=True, but they require an active
internet connection in order to load the plotly.js library.
If 'directory', a script tag is included that references an external
plotly.min.js bundle that is assumed to reside in the same
directory as the HTML file. If `file` is a string to a local file
path and `full_html` is True, then the plotly.min.js bundle is copied
into the directory of the resulting HTML file. If a file named
plotly.min.js already exists in the output directory then this file
is left unmodified and no copy is performed. HTML files generated
with this option can be used offline, but they require a copy of
the plotly.min.js bundle in the same directory. This option is
useful when many figures will be saved as HTML files in the same
directory because the plotly.js source code will be included only
once per output directory, rather than once per output file.
If 'require', Plotly.js is loaded using require.js. This option
assumes that require.js is globally available and that it has been
globally configured to know how to find Plotly.js as 'plotly'.
This option is not advised when full_html=True as it will result
in a non-functional html file.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point
the resulting HTML file to an alternative CDN or local bundle.
If False, no script tag referencing plotly.js is included. This is
useful when the resulting div string will be placed inside an HTML
document that already loads plotly.js. This option is not advised
when full_html=True as it will result in a non-functional html file.
include_mathjax: bool or string (default False)
Specifies how the MathJax.js library is included in the output html
div string. MathJax is required in order to display labels
with LaTeX typesetting.
If False, no script tag referencing MathJax.js will be included in the
output.
If 'cdn', a script tag that references a MathJax CDN location will be
included in the output. HTML div strings generated with this option
will be able to display LaTeX typesetting as long as internet access
is available.
If a string that ends in '.js', a script tag is included that
references the specified path. This approach can be used to point the
resulting HTML div string to an alternative CDN.
post_script: str or list or None (default None)
JavaScript snippet(s) to be included in the resulting div just after
plot creation. The string(s) may include '{plot_id}' placeholders
that will then be replaced by the `id` of the div element that the
plotly.js figure is associated with. One application for this script
is to install custom plotly.js event handlers.
full_html: bool (default True)
If True, produce a string containing a complete HTML document
starting with an <html> tag. If False, produce a string containing
a single <div> element.
animation_opts: dict or None (default None)
dict of custom animation parameters to be passed to the function
Plotly.animate in Plotly.js. See
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
for available options. Has no effect if the figure does not contain
frames, or auto_play is False.
default_width, default_height: number or str (default '100%')
The default figure width/height to use if the provided figure does not
specify its own layout.width/layout.height property. May be
specified in pixels as an integer (e.g. 500), or as a css width style
string (e.g. '500px', '100%').
validate: bool (default True)
True if the figure should be validated before being converted to
JSON, False otherwise.
auto_open: bool (default True)
If True, open the saved file in a web browser after saving.
This argument only applies if `full_html` is True.
div_id: str (default None)
If provided, this is the value of the id attribute of the div tag. If None, the
id attribute is a UUID.
Returns
-------
str
Representation of figure as an HTML div string
write_image(fig, file, format=None, scale=None, width=None, height=None, validate=True, engine='auto')
Convert a figure to a static image and write it to a file or writeable
object
Parameters
----------
fig:
Figure object or dict representing a figure
file: str or writeable
A string representing a local file path or a writeable object
(e.g. a pathlib.Path object or an open file descriptor)
format: str or None
The desired image format. One of
- 'png'
- 'jpg' or 'jpeg'
- 'webp'
- 'svg'
- 'pdf'
- 'eps' (Requires the poppler library to be installed and on the PATH)
If not specified and `file` is a string then this will default to the
file extension. If not specified and `file` is not a string then this
will default to:
- `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
- `plotly.io.orca.config.default_format` if engine is "orca"
width: int or None
The width of the exported image in layout pixels. If the `scale`
property is 1.0, this will also be the width of the exported image
in physical pixels.
If not specified, will default to:
- `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
- `plotly.io.orca.config.default_width` if engine is "orca"
height: int or None
The height of the exported image in layout pixels. If the `scale`
property is 1.0, this will also be the height of the exported image
in physical pixels.
If not specified, will default to:
- `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
- `plotly.io.orca.config.default_height` if engine is "orca"
scale: int or float or None
The scale factor to use when exporting the figure. A scale factor
larger than 1.0 will increase the image resolution with respect
to the figure's layout pixel dimensions. Whereas as scale factor of
less than 1.0 will decrease the image resolution.
If not specified, will default to:
- `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
- `plotly.io.orca.config.default_scale` if engine is "orca"
validate: bool
True if the figure should be validated before being converted to
an image, False otherwise.
engine: str
Image export engine to use:
- "kaleido": Use Kaleido for image export
- "orca": Use Orca for image export
- "auto" (default): Use Kaleido if installed, otherwise use orca
Returns
-------
None
write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine=None)
Convert a figure to JSON and write it to a file or writeable
object
Parameters
----------
fig:
Figure object or dict representing a figure
file: str or writeable
A string representing a local file path or a writeable object
(e.g. a pathlib.Path object or an open file descriptor)
pretty: bool (default False)
True if JSON representation should be pretty-printed, False if
representation should be as compact as possible.
remove_uids: bool (default True)
True if trace UIDs should be omitted from the JSON representation
engine: str (default None)
The JSON encoding engine to use. One of:
- "json" for an engine based on the built-in Python json module
- "orjson" for a faster engine that requires the orjson package
- "auto" for the "orjson" engine if available, otherwise "json"
If not specified, the default engine is set to the current value of
plotly.io.json.config.default_engine.
Returns
-------
None
DATA
renderers = Renderers configuration
-----------------------
...nected'...
templates = Templates configuration
-----------------------
...gridoff...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\io\__init__.py
plotly.offline
Python Library Documentation: package plotly.offline in plotly
NAME
plotly.offline
DESCRIPTION
offline
======
This module provides offline functionality.
PACKAGE CONTENTS
_plotlyjs_version
offline
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\offline\__init__.py
plotly.tools
Python Library Documentation: module plotly.tools in plotly
NAME
plotly.tools
DESCRIPTION
tools
=====
Functions that USERS will possibly want access to.
CLASSES
builtins.object
FigureFactory
class FigureFactory(builtins.object)
| # Deprecations
|
| Static methods defined here:
|
| create_2D_density(*args, **kwargs)
|
| create_annotated_heatmap(*args, **kwargs)
|
| create_candlestick(*args, **kwargs)
|
| create_dendrogram(*args, **kwargs)
|
| create_distplot(*args, **kwargs)
|
| create_facet_grid(*args, **kwargs)
|
| create_gantt(*args, **kwargs)
|
| create_ohlc(*args, **kwargs)
|
| create_quiver(*args, **kwargs)
|
| create_scatterplotmatrix(*args, **kwargs)
|
| create_streamline(*args, **kwargs)
|
| create_table(*args, **kwargs)
|
| create_trisurf(*args, **kwargs)
|
| create_violin(*args, **kwargs)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FUNCTIONS
get_config_plotly_server_url()
Function to get the .config file's 'plotly_domain' without importing
the chart_studio package. This property is needed to compute the default
value of the plotly.js config plotlyServerURL, so it is independent of
the chart_studio integration and still needs to live in
Returns
-------
str
get_graph_obj(obj, obj_type=None)
Returns a new graph object.
OLD FUNCTION: this will *silently* strip out invalid pieces of the object.
NEW FUNCTION: no striping of invalid pieces anymore - only raises error
on unrecognized graph_objs
get_subplots(rows=1, columns=1, print_grid=False, **kwargs)
Return a dictionary instance with the subplots set in 'layout'.
Example 1:
# stack two subplots vertically
fig = tools.get_subplots(rows=2)
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x1', yaxis='y1')]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]
Example 2:
# print out string showing the subplot grid you've put in the layout
fig = tools.get_subplots(rows=3, columns=2, print_grid=True)
Keywords arguments with constant defaults:
rows (kwarg, int greater than 0, default=1):
Number of rows, evenly spaced vertically on the figure.
columns (kwarg, int greater than 0, default=1):
Number of columns, evenly spaced horizontally on the figure.
horizontal_spacing (kwarg, float in [0,1], default=0.1):
Space between subplot columns. Applied to all columns.
vertical_spacing (kwarg, float in [0,1], default=0.05):
Space between subplot rows. Applied to all rows.
print_grid (kwarg, True | False, default=False):
If True, prints a tab-delimited string representation
of your plot grid.
Keyword arguments with variable defaults:
horizontal_spacing (kwarg, float in [0,1], default=0.2 / columns):
Space between subplot columns.
vertical_spacing (kwarg, float in [0,1], default=0.3 / rows):
Space between subplot rows.
make_subplots(rows=1, cols=1, shared_xaxes=False, shared_yaxes=False, start_cell='top-left', print_grid=None, **kwargs)
Return an instance of plotly.graph_objs.Figure
with the subplots domain set in 'layout'.
Example 1:
# 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['data'] += [Scatter(x=[1,2,3], y=[2,1,2])]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]
# or see Figure.append_trace
Example 2:
# subplots with shared x axes
fig = tools.make_subplots(rows=2, shared_xaxes=True)
This is the format of your plot grid:
[ (1,1) x1,y1 ]
[ (2,1) x1,y2 ]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2])]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], yaxis='y2')]
Example 3:
# irregular subplot layout (more examples below under 'specs')
fig = tools.make_subplots(rows=2, cols=2,
specs=[[{}, {}],
[{'colspan': 2}, None]])
This is the format of your plot grid!
[ (1,1) x1,y1 ] [ (1,2) x2,y2 ]
[ (2,1) x3,y3 - ]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2])]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x3', yaxis='y3')]
Example 4:
# insets
fig = tools.make_subplots(insets=[{'cell': (1,1), 'l': 0.7, 'b': 0.3}])
This is the format of your plot grid!
[ (1,1) x1,y1 ]
With insets:
[ x2,y2 ] over [ (1,1) x1,y1 ]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2])]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]
Example 5:
# include subplot titles
fig = tools.make_subplots(rows=2, subplot_titles=('Plot 1','Plot 2'))
This is the format of your plot grid:
[ (1,1) x1,y1 ]
[ (2,1) x2,y2 ]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2])]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]
Example 6:
# Include subplot title on one plot (but not all)
fig = tools.make_subplots(insets=[{'cell': (1,1), 'l': 0.7, 'b': 0.3}],
subplot_titles=('','Inset'))
This is the format of your plot grid!
[ (1,1) x1,y1 ]
With insets:
[ x2,y2 ] over [ (1,1) x1,y1 ]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2])]
fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]
Keywords arguments with constant defaults:
rows (kwarg, int greater than 0, default=1):
Number of rows in the subplot grid.
cols (kwarg, int greater than 0, default=1):
Number of columns in the subplot grid.
shared_xaxes (kwarg, boolean or list, default=False)
Assign shared x axes.
If True, subplots in the same grid column have one common
shared x-axis at the bottom of the gird.
To assign shared x axes per subplot grid cell (see 'specs'),
send list (or list of lists, one list per shared x axis)
of cell index tuples.
shared_yaxes (kwarg, boolean or list, default=False)
Assign shared y axes.
If True, subplots in the same grid row have one common
shared y-axis on the left-hand side of the gird.
To assign shared y axes per subplot grid cell (see 'specs'),
send list (or list of lists, one list per shared y axis)
of cell index tuples.
start_cell (kwarg, 'bottom-left' or 'top-left', default='top-left')
Choose the starting cell in the subplot grid used to set the
domains of the subplots.
print_grid (kwarg, boolean, default=True):
If True, prints a tab-delimited string representation of
your plot grid.
Keyword arguments with variable defaults:
horizontal_spacing (kwarg, float in [0,1], default=0.2 / cols):
Space between subplot columns.
Applies to all columns (use 'specs' subplot-dependents spacing)
vertical_spacing (kwarg, float in [0,1], default=0.3 / rows):
Space between subplot rows.
Applies to all rows (use 'specs' subplot-dependents spacing)
subplot_titles (kwarg, list of strings, default=empty list):
Title of each subplot.
"" can be included in the list if no subplot title is desired in
that space so that the titles are properly indexed.
specs (kwarg, list of lists of dictionaries):
Subplot specifications.
ex1: specs=[[{}, {}], [{'colspan': 2}, None]]
ex2: specs=[[{'rowspan': 2}, {}], [None, {}]]
- Indices of the outer list correspond to subplot grid rows
starting from the bottom. The number of rows in 'specs'
must be equal to 'rows'.
- Indices of the inner lists correspond to subplot grid columns
starting from the left. The number of columns in 'specs'
must be equal to 'cols'.
- Each item in the 'specs' list corresponds to one subplot
in a subplot grid. (N.B. The subplot grid has exactly 'rows'
times 'cols' cells.)
- Use None for blank a subplot cell (or to move pass a col/row span).
- Note that specs[0][0] has the specs of the 'start_cell' subplot.
- Each item in 'specs' is a dictionary.
The available keys are:
* is_3d (boolean, default=False): flag for 3d scenes
* colspan (int, default=1): number of subplot columns
for this subplot to span.
* rowspan (int, default=1): number of subplot rows
for this subplot to span.
* l (float, default=0.0): padding left of cell
* r (float, default=0.0): padding right of cell
* t (float, default=0.0): padding right of cell
* b (float, default=0.0): padding bottom of cell
- Use 'horizontal_spacing' and 'vertical_spacing' to adjust
the spacing in between the subplots.
insets (kwarg, list of dictionaries):
Inset specifications.
- Each item in 'insets' is a dictionary.
The available keys are:
* cell (tuple, default=(1,1)): (row, col) index of the
subplot cell to overlay inset axes onto.
* is_3d (boolean, default=False): flag for 3d scenes
* l (float, default=0.0): padding left of inset
in fraction of cell width
* w (float or 'to_end', default='to_end') inset width
in fraction of cell width ('to_end': to cell right edge)
* b (float, default=0.0): padding bottom of inset
in fraction of cell height
* h (float or 'to_end', default='to_end') inset height
in fraction of cell height ('to_end': to cell top edge)
column_width (kwarg, list of numbers)
Column_width specifications
- Functions similarly to `column_width` of `plotly.graph_objs.Table`.
Specify a list that contains numbers where the amount of numbers in
the list is equal to `cols`.
- The numbers in the list indicate the proportions that each column
domains take across the full horizontal domain excluding padding.
- For example, if columns_width=[3, 1], horizontal_spacing=0, and
cols=2, the domains for each column would be [0. 0.75] and [0.75, 1]
row_width (kwargs, list of numbers)
Row_width specifications
- Functions similarly to `column_width`. Specify a list that contains
numbers where the amount of numbers in the list is equal to `rows`.
- The numbers in the list indicate the proportions that each row
domains take along the full vertical domain excluding padding.
- For example, if row_width=[3, 1], vertical_spacing=0, and
cols=2, the domains for each row from top to botton would be
[0. 0.75] and [0.75, 1]
mpl_to_plotly(fig, resize=False, strip_style=False, verbose=False)
Convert a matplotlib figure to plotly dictionary and send.
All available information about matplotlib visualizations are stored
within a matplotlib.figure.Figure object. You can create a plot in python
using matplotlib, store the figure object, and then pass this object to
the fig_to_plotly function. In the background, mplexporter is used to
crawl through the mpl figure object for appropriate information. This
information is then systematically sent to the PlotlyRenderer which
creates the JSON structure used to make plotly visualizations. Finally,
these dictionaries are sent to plotly and your browser should open up a
new tab for viewing! Optionally, if you're working in IPython, you can
set notebook=True and the PlotlyRenderer will call plotly.iplot instead
of plotly.plot to have the graph appear directly in the IPython notebook.
Note, this function gives the user access to a simple, one-line way to
render an mpl figure in plotly. If you need to trouble shoot, you can do
this step manually by NOT running this fuction and entereing the following:
===========================================================================
from plotly.matplotlylib import mplexporter, PlotlyRenderer
# create an mpl figure and store it under a varialble 'fig'
renderer = PlotlyRenderer()
exporter = mplexporter.Exporter(renderer)
exporter.run(fig)
===========================================================================
You can then inspect the JSON structures by accessing these:
renderer.layout -- a plotly layout dictionary
renderer.data -- a list of plotly data dictionaries
return_figure_from_figure_or_data(figure_or_data, validate_figure)
warning_on_one_line(message, category, filename, lineno, file=None, line=None)
# Warning format
DATA
ALTERNATIVE_HISTNORM = 'probability'
DEFAULT_FILLCOLOR = '#1f77b4'
DEFAULT_HISTNORM = 'probability density'
DEFAULT_PLOTLY_COLORS = ['rgb(31, 119, 180)', 'rgb(255, 127, 14)', 'rg...
DIAG_CHOICES = ['scatter', 'histogram', 'box']
PLOTLY_DIR = r'C:\Users\Youse\.plotly'
PLOTLY_SCALES = {'Blackbody': ['rgb(0,0,0)', 'rgb(160,200,255)'], 'Blu...
REQUIRED_GANTT_KEYS = ['Task', 'Start', 'Finish']
VALID_COLORMAP_TYPES = ['cat', 'seq']
sage_salvus = None
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\tools.py
plotly.utils
Python Library Documentation: module plotly.utils in plotly
NAME
plotly.utils
CLASSES
builtins.object
ElidedWrapper
pprint.PrettyPrinter(builtins.object)
ElidedPrettyPrinter
class ElidedPrettyPrinter(pprint.PrettyPrinter)
| ElidedPrettyPrinter(*args, **kwargs)
|
| PrettyPrinter subclass that elides long lists/arrays/strings
|
| Method resolution order:
| ElidedPrettyPrinter
| pprint.PrettyPrinter
| builtins.object
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| Handle pretty printing operations onto a stream using a set of
| configured parameters.
|
| indent
| Number of spaces to indent for each level of nesting.
|
| width
| Attempted maximum number of columns in the output.
|
| depth
| The maximum depth to print out nested structures.
|
| stream
| The desired output stream. If omitted (or false), the standard
| output stream available at construction will be used.
|
| compact
| If true, several items will be combined in one line.
|
| sort_dicts
| If true, dict keys are sorted.
|
| underscore_numbers
| If true, digit groups are separated with underscores.
|
| ----------------------------------------------------------------------
| Methods inherited from pprint.PrettyPrinter:
|
| format(self, object, context, maxlevels, level)
| Format object for a specific context, returning a string
| and flags indicating whether the representation is 'readable'
| and whether the object represents a recursive construct.
|
| isreadable(self, object)
|
| isrecursive(self, object)
|
| pformat(self, object)
|
| pprint(self, object)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from pprint.PrettyPrinter:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ElidedWrapper(builtins.object)
| ElidedWrapper(v, threshold, indent)
|
| Helper class that wraps values of certain types and produces a custom
| __repr__() that may be elided and is suitable for use during pretty
| printing
|
| Methods defined here:
|
| __init__(self, v, threshold, indent)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| is_wrappable(v)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FUNCTIONS
decode_unicode(coll)
get_by_path(obj, path)
Iteratively get on obj for each key in path.
:param (list|dict) obj: The top-level object.
:param (tuple[str]|tuple[int]) path: Keys to access parts of obj.
:return: (*)
Example:
>>> figure = {'data': [{'x': [5]}]}
>>> path = ('data', 0, 'x')
>>> get_by_path(figure, path)
[5]
node_generator(node, path=())
General, node-yielding generator.
Yields (node, path) tuples when it finds values that are dict
instances.
A path is a sequence of hashable values that can be used as either keys to
a mapping (dict) or indices to a sequence (list). A path is always wrt to
some object. Given an object, a path explains how to get from the top level
of that object to a nested value in the object.
:param (dict) node: Part of a dict to be traversed.
:param (tuple[str]) path: Defines the path of the current node.
:return: (Generator)
Example:
>>> for node, path in node_generator({'a': {'b': 5}}):
... print(node, path)
{'a': {'b': 5}} ()
{'b': 5} ('a',)
reduce(...)
reduce(function, iterable[, initial]) -> value
Apply a function of two arguments cumulatively to the items of a sequence
or iterable, from left to right, so as to reduce the iterable to a single
value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates
((((1+2)+3)+4)+5). If initial is present, it is placed before the items
of the iterable in the calculation, and serves as a default when the
iterable is empty.
DATA
pil_imported = True
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\plotly\utils.py